Skip to main content
POST
Send DM (XChat v3)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Parameters for sending DM via XChat v3

recipient
string
required

User id, @handle, or a group id (g...) for an existing group.

Example:

"baker_donn80196"

text
string
required

Message body.

Example:

"hello from docs"

Twitter authentication cookie or Twitter auth_token, how-to-get-twitter-cookie

Example:

"ct0=abc123... or 2c4a4e1832096aa694c739b83c83b6d96d43eba7"

media_urls
string[] | null

Public URL of one image to attach (max 1). Mutually exclusive with video_url.

Maximum array length: 1
Example:
video_url
string | null

Public http(s) URL of one video to attach (mutually exclusive with image).

Example:

"https://video.twimg.com/amplify_video/2077160248830275584/vid/avc1/320x568/kwNDLTm"

pin
string | null
default:1234

Identity PIN (default 1234).

Example:

"1234"

proxy
string | null

Optional HTTP proxy. Example: http://username:password@ip:port [blocked]

Example:

"http://username:password@ip:port"

Response

A message object.

Response for sending DM

code
integer
required

Response code

Example:

200

msg
string
required

Message sent

Example:

"success"

data
MessageModel · object | null
required

message object

Example: