v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
Messages

Send a group MMS message

post/messages/group_mms

Request body

fromstring required

Phone number, in +E.164 format, used to send the message.

media_urlsstring[]

A list of media URLs. The total media size must be less than 1 MB.

subjectstring

Subject of multimedia message

textstring

Message body (i.e., content) as a non-empty string.

toToNumber[] required

A list of destinations. No more than 8 destinations are allowed.

use_profile_webhooksboolean

If the profile this number is associated with has webhooks, use them for delivery notifications. If webhooks are also specified on the message itself, they will be attempted first, then those on the profile.

webhook_failover_urlstring url

The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.

webhook_urlstring url

The URL where webhooks related to this message will be sent.

Example request

{
  "from": "+13125551234",
  "media_urls": [
    "http://example.com"
  ],
  "subject": "From Telnyx!",
  "text": "Hello, World!",
  "to": [
    "+18655551234",
    "+14155551234"
  ],
  "use_profile_webhooks": true,
  "webhook_failover_url": "https://backup.example.com/hooks",
  "webhook_url": "http://example.com/webhooks"
}

Response

Successful response with details about a message.

Example response

{
  "data": {
    "cc": [],
    "completed_at": null,
    "cost": {
      "amount": "0.0051",
      "currency": "USD"
    },
    "cost_breakdown": {
      "carrier_fee": {
        "amount": "0.00305",
        "currency": "USD"
      },
      "rate": {
        "amount": "0.00205",
        "currency": "USD"
      }
    },
    "direction": "outbound",
    "encoding": "GSM-7",
    "errors": [],
    "from": {
      "carrier": "TELNYX LLC",
      "line_type": "VoIP",
      "phone_number": "+18445550001"
    },
    "id": "40385f64-5717-4562-b3fc-2c963f66afa6",
    "media": [
      {
        "content_type": null,
        "sha256": null,
        "size": null,
        "url": "https://pbs.twimg.com/profile_images/1142168442042118144/AW3F4fFD_400x400.png"
      }
    ],
    "messaging_profile_id": "4000eba1-a0c0-4563-9925-b25e842a7cb6",
    "num_chars": 13,
    "organization_id": "b448f9cc-a842-4784-98e9-03c1a5872950",
    "parts": 1,
    "received_at": "2019-01-23T18:10:02.574Z",
    "record_type": "message",
    "sent_at": null,
    "subject": "From Telnyx!",
    "tags": [
      "Greetings"
    ],
    "tcr_campaign_billable": true,
    "tcr_campaign_id": "TCPA3X7",
    "tcr_campaign_registered": "REGISTERED",
    "text": "Hello, World!",
    "to": [
      {
        "carrier": "T-MOBILE USA, INC.",
        "line_type": "Wireless",
        "phone_number": "+18665550001",
        "status": "queued"
      }
    ],
    "type": "MMS",
    "valid_until": null,
    "wait_seconds": 0.5,
    "webhook_failover_url": "https://backup.example.com/hooks",
    "webhook_url": "https://www.example.com/hooks"
  }
}