Talkative
Talkative
Talkative

Send Outbound SMS

Sends an SMS to a customer through Talkative and logs it as an interaction.

Unverified

What the model is told

Send an SMS to a customer. Confirm the mobile number and the message with the customer before sending. A successful send returns no content, so tell the customer the message is on its way. If the request fails, say you could not send the message rather than trying again.

Request

POSThttps://YOUR_REGION.engage.app/api/core/v1/interactions/sms

Headers

  • Content-Typeapplication/json
  • AuthorizationBearer YOUR_CORE_API_TOKEN

Body

{
  "to": "{{to}}",
  "body": "{{body}}",
  "queue_uuid": "YOUR_QUEUE_UUID"
}

Parameters

  • to stringThe customer's mobile number in E.164 format: a plus sign followed by 10 to 15 digits, with no spaces.
  • body stringThe text of the SMS, up to 4096 characters. Plain text only, with no double quotes or line breaks.

Engage payload

{
  "source": "VOICE_AI",
  "tool": {
    "id": "d2cb58ca-6a4c-4587-b3c9-1556f34cae8f",
    "type": "HTTP_REQUEST",
    "label": "Send Outbound SMS",
    "name": "send_outbound_sms",
    "customName": false,
    "description": "Send an SMS to a customer. Confirm the mobile number and the message with the customer before sending. A successful send returns no content, so tell the customer the message is on its way. If the request fails, say you could not send the message rather than trying again.",
    "parameters": [
      {
        "name": "to",
        "type": "string",
        "description": "The customer's mobile number in E.164 format: a plus sign followed by 10 to 15 digits, with no spaces."
      },
      {
        "name": "body",
        "type": "string",
        "description": "The text of the SMS, up to 4096 characters. Plain text only, with no double quotes or line breaks."
      }
    ],
    "config": {
      "endpoint": {
        "method": "POST",
        "url": "https://YOUR_REGION.engage.app/api/core/v1/interactions/sms"
      },
      "headers": [
        {
          "name": "Content-Type",
          "value": "application/json"
        },
        {
          "name": "Authorization",
          "value": "Bearer YOUR_CORE_API_TOKEN"
        }
      ],
      "body": "{\n  \"to\": \"{{to}}\",\n  \"body\": \"{{body}}\",\n  \"queue_uuid\": \"YOUR_QUEUE_UUID\"\n}",
      "timeout": null
    }
  }
}

IDs are regenerated on every copy.