💬Send messages via Text-Call ID

reply-from-external support scope description

1. Please note,reply-from-external only supports message channels,does not support phone calls 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 agent" stage, namely text_call status must be status = 1. If the current conversation has not yet been taken by an agent (i.e., is in a pending state), this endpoint cannot be successfully triggered. Please confirm the status before calling.

This API can send messages to the system by specifying the Text-Call ID (conversation identifier) to send messages to the system.

• Ways to obtain the conversation identifier:

  • Through variables in the script flow

  • By decrypting the encrypted code in the message template

• Use cases:

  • Automatically send specified messages within the script flow

  • Integrate with other systems, using the conversation identifier to precisely locate and operate on the conversation

  • Create automated applications, such as sending notifications, creating reminders, or triggering subsequent processes

This design enables more flexible scenario usage, strengthening the automation and integration capabilities of conversations.

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 send was successful.

{}

Http Request

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

URL Parameters

Parameter	Description
text_call	Conversation ID

Form Data

Field Name	Type	Required	Example Value	Description
content	String	✅	"Hello, this is your message content"	The main body of the message. It can be a message the customer will see 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