Logs


Fetch a Log

Return json data about a log.

URL

/logs/:id

Method

GET

Success Response

Code: 200
Content:

{
"platform": "sms_with_secure_link",
"message": "Hello World!",
"is_final": true,
"platform_reference_id": "12345",
"recipient_phone": "+1234567890",
"sender_phone": "+0987654321",
"outbound": true,
"sent_at": "yyyy-MM-dd'T'HH:mm:ss'Z'",
"delivered_at": "yyyy-MM-dd'T'HH:mm:ss'Z'",
"read_at": "yyyy-MM-dd'T'HH:mm:ss'Z'",
"failed_at": "yyyy-MM-dd'T'HH:mm:ss'Z'",
"created_at": "yyyy-MM-dd'T'HH:mm:ss'Z'",
"updated_at": "yyyy-MM-dd'T'HH:mm:ss'Z'",
"id": "123f2db6-4558-46f9-90d8-8e6765c5b857"
}

Fetch Logs

Return json data about logs. Default response is a paginated list scoped by customer.

URL

/logs

Method

GET

Data parameters

text_id=[string] ID of an associated text message.

conversation_id=[string] ID of an associated conversation

phone_number=[string] Phone number associated to a conversation

page=[integer] Page number to return.

items=[integer] How many items per page.

order=[string] Direction to sort.

order_by=[string] Field to sort on.

Success Response

Code: 200
Content:

{
"data": [{
"platform": "sms_with_secure_link",
"message": "Hello World!",
"is_final": true,
"platform_reference_id": "12345",
"recipient_phone": "+1234567890",
"sender_phone": "+0987654321",
"outbound": true,
"sent_at": "yyyy-MM-dd'T'HH:mm:ss'Z'",
"delivered_at": "yyyy-MM-dd'T'HH:mm:ss'Z'",
"read_at": "yyyy-MM-dd'T'HH:mm:ss'Z'",
"failed_at": "yyyy-MM-dd'T'HH:mm:ss'Z'",
"created_at": "yyyy-MM-dd'T'HH:mm:ss'Z'",
"updated_at": "yyyy-MM-dd'T'HH:mm:ss'Z'",
"id": "123f2db6-4558-46f9-90d8-8e6765c5b857"
}]
}