> For the complete documentation index, see [llms.txt](https://help.clickatell.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.clickatell.com/developers-api-reference/models.md).

# Models

## The Sms status callback object

```json
{"openapi":"3.0.1","info":{"title":"SMS API","version":"1.0.0"},"components":{"schemas":{"Sms status callback":{"type":"object","properties":{"integrationName":{"type":"string"},"messageId":{"type":"string"},"requestId":{"type":"string"},"clientMessageId":{"type":"string"},"to":{"type":"string"},"from":{"type":"string"},"statusCode":{"type":"integer","format":"int32"},"status":{"type":"string"},"statusDescription":{"type":"string"},"timestamp":{"type":"string"}}}}}}
```

## The SendReplyMessageRequest object

```json
{"openapi":"3.0.1","info":{"title":"SMS API","version":"1.0.0"},"components":{"schemas":{"SendReplyMessageRequest":{"type":"object","properties":{"integrationName":{"type":"string"},"replyMessageId":{"type":"string"},"messageId":{"type":"string"},"fromNumber":{"type":"string"},"toNumber":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"text":{"type":"string"},"charset":{"type":"string"},"udh":{"type":"string"},"network":{"type":"integer","format":"int32"},"keyword":{"type":"string"}}}}}}
```

## The SendMessageRequest object

```json
{"openapi":"3.0.1","info":{"title":"SMS API","version":"1.0.0"},"components":{"schemas":{"SendMessageRequest":{"type":"object","properties":{"content":{"type":"string","xml":{"name":"Content"}},"to":{"uniqueItems":true,"type":"array","xml":{"name":"To"},"items":{"type":"string","xml":{"name":"To"}}},"from":{"type":"string","xml":{"name":"From"}},"binary":{"type":"boolean","xml":{"name":"Binary"}},"clientMessageId":{"type":"string","xml":{"name":"ClientMessageId"}},"scheduledDeliveryTime":{"type":"string","xml":{"name":"ScheduledDeliveryTime"}},"userDataHeader":{"maxLength":2147483647,"minLength":1,"type":"string","xml":{"name":"UserDataHeader"}},"validityPeriod":{"type":"integer","format":"int32","xml":{"name":"ValidityPeriod"}},"charset":{"type":"string","xml":{"name":"Charset"}}},"description":"Send sms request","xml":{"name":"SendMessageRequest"}}}}}
```

## The SendMessageResponse object

```json
{"openapi":"3.0.1","info":{"title":"SMS API","version":"1.0.0"},"components":{"schemas":{"SendMessageResponse":{"type":"object","properties":{"apiMessageId":{"type":"string","xml":{"name":"ApiMessageId"}},"accepted":{"type":"boolean","xml":{"name":"Accepted"}},"to":{"type":"string","xml":{"name":"To"}},"errorCode":{"type":"integer","format":"int32","xml":{"name":"ErrorCode"}},"error":{"type":"string","xml":{"name":"Error"}},"errorDescription":{"type":"string","xml":{"name":"ErrorDescription"}}}}}}}
```

## The SendMessagesListResponse object

```json
{"openapi":"3.0.1","info":{"title":"SMS API","version":"1.0.0"},"components":{"schemas":{"SendMessagesListResponse":{"type":"object","properties":{"messages":{"type":"array","xml":{"name":"Messages","wrapped":true},"items":{"$ref":"#/components/schemas/SendMessageResponse"}},"errorCode":{"type":"integer","format":"int32","xml":{"name":"ErrorCode"}},"error":{"type":"string","xml":{"name":"Error"}},"errorDescription":{"type":"string","xml":{"name":"ErrorDescription"}}},"xml":{"name":"SendMessagesResponse"}},"SendMessageResponse":{"type":"object","properties":{"apiMessageId":{"type":"string","xml":{"name":"ApiMessageId"}},"accepted":{"type":"boolean","xml":{"name":"Accepted"}},"to":{"type":"string","xml":{"name":"To"}},"errorCode":{"type":"integer","format":"int32","xml":{"name":"ErrorCode"}},"error":{"type":"string","xml":{"name":"Error"}},"errorDescription":{"type":"string","xml":{"name":"ErrorDescription"}}}}}}}
```

## The SendBulkMessageRequest object

```json
{"openapi":"3.0.1","info":{"title":"SMS API","version":"1.0.0"},"components":{"schemas":{"SendBulkMessageRequest":{"type":"object","properties":{"messageList":{"type":"array","items":{"$ref":"#/components/schemas/SendMessageRequest"}}}},"SendMessageRequest":{"type":"object","properties":{"content":{"type":"string","xml":{"name":"Content"}},"to":{"uniqueItems":true,"type":"array","xml":{"name":"To"},"items":{"type":"string","xml":{"name":"To"}}},"from":{"type":"string","xml":{"name":"From"}},"binary":{"type":"boolean","xml":{"name":"Binary"}},"clientMessageId":{"type":"string","xml":{"name":"ClientMessageId"}},"scheduledDeliveryTime":{"type":"string","xml":{"name":"ScheduledDeliveryTime"}},"userDataHeader":{"maxLength":2147483647,"minLength":1,"type":"string","xml":{"name":"UserDataHeader"}},"validityPeriod":{"type":"integer","format":"int32","xml":{"name":"ValidityPeriod"}},"charset":{"type":"string","xml":{"name":"Charset"}}},"description":"Send sms request","xml":{"name":"SendMessageRequest"}}}}}
```
