Send a SMS

This endpoint allows you to send an SMS to a customer registered in the system. The SMS can be customized with a specific message and is delivered to the customer’s phone number associated with their

Please note that the SMS module must be activated for this endpoint to function correctly.

post

Send an SMS to a customer.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Bearer {apikey}

Path parameters

agentIdstringRequired

The ID of the agent.

customerIdstringRequired

The ID of the customer.

Body

application/json

messagestringRequired

The body of the SMS message.

Example: Hello, this is a test message.

phoneNumberstringOptional

The phone number to send the SMS to.

Example: [phone]

mediaUrlsstring[]Optional

The URLs of the media to send with the SMS.

Example: ["https://www.google.com/images/branding/googlelogo/1x/googlelogo_color_272x92dp.png"]

Responses

200

The SMS was sent successfully.

application/json

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post

/v1/agents/{agentId}/customers/{customerId}/sms

HTTPcURLJavaScriptPython

POST /v1/agents/{agentId}/customers/{customerId}/sms HTTP/1.1
Host: api.voxity.ai
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 171

{
  "message": "Hello, this is a test message.",
  "phoneNumber": "[phone]",
  "mediaUrls": [
    "https://www.google.com/images/branding/googlelogo/1x/googlelogo_color_272x92dp.png"
  ]
}

{
  "code": "SMS_SENT",
  "message": "The SMS was sent successfully."
}