Sign in

v1

latestSwagger 2.02026-08-06114161439.7 KB
sms

Send sms to first sms enable TN for provided campaign

Sends an SMS message from the first SMS-enabled tracking number associated with a specified campaign. Used for outbound text messaging to customers via campaign tracking numbers.

post/sms

Request body

campaign_idinteger

Unique identifier for the campaign this call was attributed to. Integer.

tracking_numberstring

Phone number the caller dialed (the tracking/DNI number). Convirza routes calls from this number through the configured call flow. String of digits.

destination_numberstring required

destination number to which sms should be sent. Type: string.

messagestring required

SMS message body. String. Max length set by carrier (typically 160 chars for single-segment, up to 1600 for concatenated).

sms_type'outgoing' | 'incoming'

sms_type. Type: enum (string); Allowed values: outgoing, incoming.

send_opt_in_msgboolean

Indicates whether the opt-in messages to be sent or not. Type: boolean.

opt_in_msgstring

content of the otp-in message to the customer to be sent. Type: string.

agent_notificationstring

content of the agent notification to be sent. Type: string.

Example request

{
  "campaign_id": 4421,
  "tracking_number": "+13856254524",
  "destination_number": "+13856254524",
  "message": "this a test message",
  "opt_in_msg": "Welcome to agency, thank you for connecting to us.",
  "agent_notification": "This is lead coming from our website"
}

Response

Confirmation of SMS submission with unique message ID, delivery status, and message details

resultstring required

Outcome of the request. String, typically 'success' or 'error'.

errstring

Error message if result is error. Null if successful.

Example response

{
  "result": "success",
  "data": {
    "sms_id": "11551",
    "conversation_id": 3273
  }
}