For the complete documentation index, see llms.txt. This page is also available as Markdown.

💬Send message via Text Call ID

reply-from-external support scope description

  1. Please note,reply-from-external only supports message channels,does not support phone or other sources. If you need to apply it to phone-related scenarios, please plan an alternative solution separately.

  2. This API is only applicable to conversation flows that have entered the "human customer service stage", that is, text_call the status must be status = 1. If the current conversation has not yet been taken over by a human agent (that is, it is in a pending assignment state), this endpoint cannot be triggered successfully. Please make sure to confirm the status before making the call. </aside>

This API can use the specified Text-Call ID (conversation identifier) to send messages to the system side.

  • Ways to obtain the conversation identifier:

    • Through variables in the script flow

    • Through decryption of the message template's encryption code

  • Use cases:

    • Automatically send specified messages in the script flow

    • Integrate with other systems, using the conversation identifier to accurately locate the conversation and perform operations

    • Build automated applications, such as sending notifications, creating reminders, or triggering follow-up processes

This design supports more flexible scenario usage, making conversation automation and integration capabilities stronger.

API

curl -X POST "https://{API_HOST}/api/v1/text-call/{text_call}/reply-from-external" \\
  -H "Content-Type: application/json" \\
  -d '{
    "content": "Hello, this is your message content.",
    "is_note": false
}'

Response

The response is in JSON format, and the HTTP status code is 204, indicating the message was sent successfully.

Copy

Http Request

POST https://{API_HOST}/api/v1/text-call/{text_call}/reply-from-external

URL Parameters

text_call

Conversation ID

Form Data

content

String

✅

"Hello, this is your message content"

The main content of the message. It can be a message visible to the customer, or a note for internal system members only. Cannot be empty.

is_note

Number

0 / 1

Indicates whether it is a note (the customer will not see it).- 1 → Note- 0 → Visible to customer

Last updated