메인 콘텐츠로 건너뛰기

​
하위 모듈

​
모듈 내용

이 모듈은 X API의 다이렉트 메시지 엔드포인트에 대한 접근을 제공하며, 다이렉트 메시지 관련 모든 기능을 위한 기본 진입점입니다.

​
class xdk.direct_messages.DirectMessagesClient

다이렉트 메시지 관련 작업을 위한 Client

​
매개변수

​
path.client
Client

​
__init__

​
매개변수

​
path.client
Client

​
create_by_conversation_id

대화 id로 DM 메시지 생성 지정된 id를 가진 대화로 새 다이렉트 메시지를 전송합니다.

​
매개변수

​
path.dm_conversation_id
str
DM 대화 ID입니다.
​
body.body
CreateByConversationIdRequest
요청 본문

​
create_by_participant_id

참가자 ID로 DM 메시지 생성 특정 참가자의 ID를 사용하여 해당 참가자에게 새 다이렉트 메시지를 전송합니다.

​
매개변수

​
path.participant_id
Any
DM을 받게 될 수신 사용자 ID입니다.
​
body.body
CreateByParticipantIdRequest
요청 본문

​
create_conversation

DM 대화 생성 지정된 참가자와 새 다이렉트 메시지 대화를 시작합니다. body: 요청 본문 :returns: 응답 데이터 :rtype: CreateConversationResponse

​
매개변수

​
body.body
CreateConversationRequest

​
delete_events

DM 이벤트 삭제 인증된 사용자가 소유한 경우, 해당 ID를 사용해 특정 다이렉트 메시지 이벤트를 삭제합니다.

​
매개변수

​
path.event_id
Any
삭제할 다이렉트 메시지 이벤트의 ID입니다.

​
반환값

DeleteEventsResponse - 응답 데이터

​
get_events

DM 이벤트 가져오기 모든 대화에 걸쳐 최근 다이렉트 메시지 이벤트의 리스트를 조회합니다.

​
매개변수

​
path.max_results
int or None
기본값:"None"
결과의 최대 개수입니다.
​
path.pagination_token
Any or None
기본값:"None"
결과의 특정 “페이지”를 가져오는 데 사용되는 매개변수입니다.
​
path.event_types
List or None
기본값:"None"
결과에 포함할 event_types 모음입니다.
​
path.dm_event_fields
List or None
기본값:"None"
표시할 DmEvent 필드의 쉼표로 구분된 목록입니다.
​
path.expansions
List or None
기본값:"None"
확장할 필드의 쉼표로 구분된 목록입니다.
​
path.media_fields
List or None
기본값:"None"
표시할 Media 필드의 쉼표로 구분된 목록입니다.
​
path.user_fields
List or None
기본값:"None"
표시할 User 필드의 쉼표로 구분된 목록입니다.
​
path.tweet_fields
List or None
기본값:"None"
표시할 Tweet 필드의 쉼표로 구분된 목록입니다.

​
반환값

IteratorGetEventsResponse

​
get_events_by_conversation_id

DM 대화의 이벤트 가져오기 특정 대화에 대한 다이렉트 메시지 이벤트를 가져옵니다.

​
매개변수

​
path.id
Any
DM 대화의 ID입니다.
​
path.max_results
int or None
기본값:"None"
결과의 최대 개수입니다.
​
path.pagination_token
Any or None
기본값:"None"
지정된 ‘페이지’의 결과를 가져오는 데 사용하는 매개변수입니다.
​
path.event_types
List or None
기본값:"None"
결과에 포함할 event_types의 집합입니다.
​
path.dm_event_fields
List or None
기본값:"None"
표시할 DmEvent 필드의 쉼표로 구분된 목록입니다.
​
path.expansions
List or None
기본값:"None"
확장할 필드의 쉼표로 구분된 목록입니다.
​
path.media_fields
List or None
기본값:"None"
표시할 Media 필드의 쉼표로 구분된 목록입니다.
​
path.user_fields
List or None
기본값:"None"
표시할 User 필드의 쉼표로 구분된 목록입니다.
​
path.tweet_fields
List or None
기본값:"None"
표시할 Tweet 필드의 쉼표로 구분된 목록입니다.

​
반환값

IteratorGetEventsByConversationIdResponse

​
get_events_by_id

ID로 DM 이벤트 가져오기 특정 다이렉트 메시지 이벤트의 상세 정보를 해당 ID를 사용해 조회합니다.

​
Parameters

​
path.event_id
Any
DM 이벤트 id입니다.
​
path.dm_event_fields
List or None
기본값:"None"
표시할 DmEvent 필드를 쉼표로 구분한 목록입니다.
​
path.expansions
List or None
기본값:"None"
확장할 필드를 쉼표로 구분한 목록입니다.
​
path.media_fields
List or None
기본값:"None"
표시할 Media 필드를 쉼표로 구분한 목록입니다.
​
path.user_fields
List or None
기본값:"None"
표시할 User 필드를 쉼표로 구분한 목록입니다.
​
path.tweet_fields
List or None
기본값:"None"
표시할 Tweet 필드를 쉼표로 구분한 목록입니다.

​
반환

GetEventsByIdResponse - 응답 데이터입니다

​
get_events_by_participant_id

특정 DM 대화의 이벤트 가져오기 특정 대화에 대한 다이렉트 메시지 이벤트를 가져옵니다.

​
Parameters

​
path.participant_id
Any
일대일 DM 대화의 참여자 사용자 ID입니다.
​
path.max_results
int or None
기본값:"None"
결과의 최대 개수입니다.
​
path.pagination_token
Any or None
기본값:"None"
지정된 ‘페이지’에 해당하는 결과를 가져오는 데 사용하는 매개변수입니다.
​
path.event_types
List or None
기본값:"None"
결과에 포함할 event_types 집합입니다.
​
path.dm_event_fields
List or None
기본값:"None"
표시할 DmEvent 필드를 쉼표로 구분한 목록입니다.
​
path.expansions
List or None
기본값:"None"
확장할 필드를 쉼표로 구분한 목록입니다.
​
path.media_fields
List or None
기본값:"None"
표시할 Media 필드를 쉼표로 구분한 목록입니다.
​
path.user_fields
List or None
기본값:"None"
표시할 User 필드를 쉼표로 구분한 목록입니다.
​
path.tweet_fields
List or None
기본값:"None"
표시할 Tweet 필드를 쉼표로 구분한 목록입니다.

​
반환값

IteratorGetEventsByParticipantIdResponse