Sign in
Message Logs

Get message log

Retrieves one historical messaging record by log ID. Use it to inspect delivery details for a known message segment; this read-only endpoint does not send, retry, or redact the message. Use List message logs to discover log IDs or Send a message for live messaging.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Messaging.

Learn more about API scopes.

get/api/messaging/logs/{id}

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of the log.

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

fromstring required

The origin phone number.

tostring required

The destination phone number.

status'queued' | 'initiated' | 'delivered' | 'sent' | 'received' | 'undelivered' | 'failed' required

The status of the message.

direction'inbound' | 'outbound' | 'outbound-api' | 'outbound-call' | 'outbound-reply' required

The direction of the message.

kind'sms' | 'mms' required

The kind of message.

source'realtime_api' | 'laml' required

Source of this log entry.

type'relay_message' | 'laml_message' required

Type of this log entry.

urlstring uri nullable required

URL for the resource associated with this log entry. Null for Relay messages.

number_of_segmentsinteger required

The number of segments.

chargenumber double required

The charge in dollars.

created_atstring date-time required

Date and time when the message entry was created.

error_messagestring nullable required

Description of the error when the message failed. Null when the message did not fail. LaML messages use the codes documented at https://signalwire.com/docs/compatibility-api/rest/error-codes.

error_codestring nullable required

Error code identifying why the message failed. Null when the message did not fail. Some Relay messages may have an error_message without an error_code — the error_code is a newer pattern that is not used in all Relay areas.

Example response

{
  "from": "+12077447397",
  "to": "+12029921413",
  "status": "failed",
  "direction": "inbound",
  "kind": "sms",
  "source": "laml",
  "type": "relay_message",
  "url": "https://example.signalwire.com/api/laml/2010-04-01/Accounts/c38dacad-2f6c-4de1-93d6-cc732e0c70c5/Messages/9ee38635-899a-490a-bfd1-9e72f5eea53c",
  "number_of_segments": 1,
  "charge_details": [
    {
      "description": "Inbound SMS",
      "charge": 0.00415
    }
  ],
  "created_at": "2024-05-06T12:20:00Z",
  "error_message": "From number is not a SMS-capable phone number.",
  "error_code": "21601"
}

Changes

Changed in 1 of the 137 revisions of this API.2

  • 849dfb1f23652See the full diff
    • ○

      added the required property error_code to the response with the 200 status

      response-required-property-added

    • ○

      added the required property error_message to the response with the 200 status

      response-required-property-added

Of the 137 revisions, 3 have a changelog that could not be searched.