Sign in
Messages

Retrieve a message

Note: This API endpoint can only retrieve messages that are no older than 10 days since their creation. If you require messages older than this, please generate an MDR report.

get/messages/{id}

Path parameters

idstring uuid required

The id of the message

Response

Successful response with details of 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"
  }
}

Changes

Changed in 2 of the 61 revisions of this API.81

  • 1571b0380bd73See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 4XX

      response-body-type-changed

    • ▲

      the errors/items/ response's property type/format changed from object/ to / for status 4XX

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 4XX

      response-property-type-changed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e53799451See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 4XX

      response-body-type-changed

    • ▲

      added messaging_OutboundMessagePayload messaging_InboundMessagePayload to the data response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      the errors/items/ response's property type/format changed from / to object/ for status 4XX

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 4XX

      response-property-type-changed

    • ▲

      the errors/items/source/pointer response's property type/format changed from string/json-pointer to string/ for status 4XX

      response-property-type-changed

    • ○

      removed OutboundMessagePayload InboundMessagePayload from the data response property oneOf list for the response status 200

      response-property-one-of-removed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog