---
title: "Send_SMS"
slug: "send-sms"
updated: 2024-10-25T11:02:05Z
published: 2024-10-25T11:02:05Z
canonical: "docs.voiso.com/send-sms"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.voiso.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Send_SMS

Post/api/v1/{api_key}/sendsms

Enables agents to send SMS messages via the API. Agents are identified by their extensions (<tt>agent</tt> parameter). The destination numbers are specified in the <tt>number</tt> parameter.

Header parametersContent-TypeRequiredValid values[
  "application/json"
]

Path parametersapi_keystringRequired

The [Contact Center API key](https://developers.voiso.com/client/#/rest/getting-started/authentication/how-to-obtain-the-contact-center-key).

Example{contact_center_api_key}

Body parameters<select class='api-response-data' aria-label='Media type'><option value='d9d005bf-0ece-4c28-a425-779d15e42dbe'>application/x-www-form-urlencoded</option>
</select>object agentinteger  (int32)    Required

Agent extension

numberstring    Required

Destination phone number

bodystring    Required

SMS body. 1-1600 chars. Links are not supported in SMS

sender_idstring    

Your call center SenderID. If this field is empty, a random SenderID from the 'Default' group is used. The request fails if you have no SenderIDs configured

crmstring    

Name of sending application or CRM

account_idstring    

The CRM Account ID for the contact at the destination number. This parameter may also be used when you specify the crm parameter.

Responses200

All parameters are valid and the SMS sending is successful.

<select class='api-response-data' aria-label='Media type'><option value='79d34b6d-9e2b-468e-b4e1-b942f0a1e0bb'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='a9cf452e-bd4e-4950-932d-6b5996066edd'>example1</option>
</select>example1

Success

SMS successfully sent

```json
{
  "sms_id": "cf283919-86f4-46a6-8b45-29bd7a752827",
  "segments": 1
}
```

Example{
  "sms_id": "cf283919-86f4-46a6-8b45-29bd7a752827",
  "segments": 1
}sms_idstring  (uuid)    
segmentsinteger  (int32)    

400

Incorrect body parameters

<select class='api-response-data' aria-label='Media type'><option value='621e73e6-5ad6-4892-987c-7e7046634a2d'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='f133e458-fd7b-45f6-8835-589e6495d2c9'>sms_error_types</option>
</select>sms_error_types

One of the Error Messages from 'SMS Error Types'

One of the Error Messages from 'SMS Error Types'

```json
{
  "error": "SMS is not allowed"
}
```

object Example{
  "error": "SMS is not allowed"
}

403

Invalid api_key

<select class='api-response-data' aria-label='Media type'><option value='1a69a138-2063-425a-b40d-79e8e005a256'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='09fc3cae-3885-4742-bc16-7373a42e1762'>example1</option>
</select>example1

Error1

Invalid API key

```json
{
  "error": "Invalid api_key"
}
```

Example{
  "error": "Invalid api_key"
}