1. OTT
Messaging API
  • Root
    • OTT
      • Send OTT
        POST
    • SMS
      • Send SMS
        • SendSms
    • Voice
      • /deliver
    • Email
      • Register an email delivery request
  • Schemas
    • Schemas
      • MessageChannel
      • ApiSmsRequest
      • VoiceApiRequest
      • EmailRecipient
      • OTTMessagePayload
      • EmailRequest
      • OTTMessageRequest
      • EmailResponse
      • EmailResult
  1. OTT

Send OTT

POST
/ott/v1/deliver
Last modified:2025-09-25 21:32:37
Processes a batch of OTT messages for delivery via configured channels (e.g., WhatsApp).
The OTTProcessingResult object represents the outcome of processing an individual OTT message within a batch request. It contains the recipient's phone number, a unique message identifier if the message was successfully queued, a status indicator ("queued" or "error"), and an optional error message describing why the message failed. This structure allows clients to correlate each input message with its delivery status and diagnose issues such as invalid templates, routing failures, or malformed data. A response may contain multiple OTTProcessingResult entries, one for each attempted delivery, enabling granular feedback and partial success handling.

Request

Authorization
Add parameter in header
X-API-KEY
Example:
X-API-KEY: ********************
Body Params application/json

Examples

Responses

🟢200Correcto
application/json
OK
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location 'https://api.trucontact.co/ott/v1/deliver' \
--header 'X-API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "payload": [
        {
            "recipient": "573000000000",
            "templateID": "FRiuyt4563234a",
            "templateParameters": [
                "12356",
                "897456"
            ],
            "channelType": 3
        }
    ]
}'
Response Response Example
Example 1
[
    {
        "recipient": "573000000000",
        "messageId": "856987ce34bca23465",
        "status": "queued",
        "error": null
    }
]
Modified at 2025-09-25 21:32:37
Next
SendSms
Built with