Your message content. Messages containing only 3GPP 7bit compatible characters can contain up to 612 characters. Messages that cannot be encoded by 3GPP must contain up to 268 characters. Mandatory: Use this or template_id.
Optionally schedule the delivery time. The campaign will be scheduled and sent at this date and time. Date format must be YYYY-MM-DD HH:MM:SS.
'
example: '2025-01-01 08:51:07'
required:
- to_list_ids
- from
/messages/send/to_numbers:
post:
summary: 'Send SMS to Numbers'
operationId: sendSMSToNumbers
description: "This endpoint allows you to Send/Schedule SMS messages to one or more recipients.\n"
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: approved
campaign_id: 68a6ce95-03b2-11ee-910d-0264ec2cd11b
total_sent: 2
invalid:
count: 0
numbers: []
properties:
status:
type: string
example: approved
campaign_id:
type: string
example: 68a6ce95-03b2-11ee-910d-0264ec2cd11b
total_sent:
type: integer
example: 2
invalid:
type: object
properties:
count:
type: integer
example: 0
numbers:
type: array
example: []
403:
description: Authentication
content:
application/json:
schema:
type: object
example:
status_code: 403
message: 'Unauthenticated - Missing/Invalid API key'
properties:
status_code:
type: integer
example: 403
message:
type: string
example: 'Unauthenticated - Missing/Invalid API key'
404:
description: 'Not Found'
content:
application/json:
schema:
type: object
example:
status_code: 404
status: declined
message: 'Template not found or not valid'
properties:
status_code:
type: integer
example: 404
status:
type: string
example: declined
message:
type: string
example: 'Template not found or not valid'
422:
description: 'Low Balance'
content:
application/json:
schema:
type: object
example:
status_code: 422
status: declined
reason: balance_low
message: 'Balance must be over $[current minimum for sending] to create or schedule new campaigns or messages'
properties:
status_code:
type: integer
example: 422
status:
type: string
example: declined
reason:
type: string
example: balance_low
message:
type: string
example: 'Balance must be over $[current minimum for sending] to create or schedule new campaigns or messages'
500:
description: 'Server Error'
content:
application/json:
schema:
type: object
example:
status_code: 500
message: 'Internal Error'
properties:
status_code:
type: integer
example: 500
message:
type: string
example: 'Internal Error'
tags:
- 'Send SMS'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
to_numbers:
type: array
description: '
required
Array of E.164 formatted phone numbers. Can contain up to 500 entries. If array contains only a single entry, the message will be sent as a single message.
Your message content. Messages containing only 3GPP 7bit compatible characters can contain up to 612 characters. Messages that cannot be encoded by 3GPP must contain up to 268 characters. Mandatory: Use this or template_id.
Optionally set brand containing only 3GPP 7bit compatible characters can contain up to 50 characters. Brands that cannot be encoded by 3GPP must contain up to 12 characters.