Skip to navigation
LogsMessage Logs

Get message log

View as MarkdownOpen in Claude

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.

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

Path parameters

idstringRequiredformat: "uuid"
Unique ID of the log.

Response

The request has succeeded.
idstringformat: "uuid"
A unique identifier for the log.
fromstring
The origin phone number.
tostring
The destination phone number.
statusenum
The status of the message.
directionenum
The direction of the message.
Allowed values:
kindenum
The kind of message.
Allowed values:
sourceenum
Source of this log entry.
Allowed values:
typeenum
Type of this log entry.
Allowed values:
urlstring or nullformat: "uri"
URL for the resource associated with this log entry. Null for Relay messages.
number_of_segmentsinteger
The number of segments.
chargedouble
The charge in dollars.
charge_detailslist of objects
Details on charges associated with this log.
created_atdatetime
Date and time when the message entry was created.
error_messagestring or null

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 or null

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.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error