Assistant Sms Chat

Send an SMS message for an assistant. This endpoint:

1. Validates the assistant exists and has messaging profile configured
2. If should_create_conversation is true, creates a new conversation with metadata
3. Sends the SMS message (If text is set, this will be sent. Otherwise, if this is the first message in the conversation and the assistant has a greeting configured, this will be sent. Otherwise the assistant will generate the text to send.)
4. Updates conversation metadata if provided
5. Returns the conversation ID

POST /ai/assistants/{assistant_id}/chat/sms

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.ai.assistants.sendSMS('assistant_id', { from: 'from', to: 'to' });

console.log(response.conversation_id);

200

{
  "conversation_id": "<string>"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

assistant_id · string · required

Body

application/json

from · string · required

to · string · required

text · string

conversation_metadata · Conversation Metadata · object

Show child attributes

should_create_conversation · boolean

Response

200

application/json

Successful Response

conversation_id · string