API Reference

Getting Started

Send images and files

Check channel support, provide a reachable media URL, and select a supported message type.

Getting started

  1. 1

    Before you call

    Check channel support, provide a reachable media URL, and select a supported message type.

    Unified message sending support
  2. 2

    Prepare your parameters

    For a reply, copy data.conversation.id and data.conversation.type from message.received into to.id and to.type. For a new recipient, follow the channel-specific identifier rules.

    Send text message
  3. 3

    Send media message

    Check channel support, provide a reachable media URL, and select a supported message type.

    curl -X POST "https://api.unifyport.ai/v1/messages" \
      -H "X-Api-Key: <YOUR_API_KEY>" \
      -H "Content-Type: application/json" \
      -d '{
      "account_id": "acc_example",
      "to": {
        "id": "user_example",
        "type": "user"
      },
      "message": {
        "type": "video",
        "url": "https://cdn.example.com/video/demo.mp4",
        "caption": "hello video"
      },
      "provider_data": {
        "seconds": 12
      }
    }'
    Send media message
  4. 4

    Understand the result

    Save message_id and provider_ref to correlate later events or troubleshoot. accepted is not a delivery receipt. Use receipt events only where the channel supports them; identifier formats vary by channel.

    Webhook delivery & signature verification