Skip to main content

Voyado Engage

Get historical messages for contact

With a single call, the Engage API can fetch the latest SMS and email messages saved for a specific contact.

https://[client].voyado.com/api/v2/contacts/{ContactId}/messages/latest

By default, the latest 100 messages will be fetched. By adding the parameter count to your query, you can request any number up to the maximum of 500. A query to this endpoint will look like this:

https://[client].voyado.com/api/v2/contacts/111d3329-7eef-45c0-37f9-ae9300a0dacei/messages/latest?count=350

Note

This endpoint is primary for first-line support platforms, allowing customer service employees to quickly troubleshoot a contact's sent messages without having to log into Voyado Engage.

Response codes

You'll get one of these two response codes:

'200' : OK

'404' : ContactNotFound

Response

{
    "count": 2,
    "items": [
        {
            "messageId": "c524e468-cee9-43d5-8f46-af3801140340",
            "name": "test",
            "sendDateTime": "2022-10-24T16:47:45+00:00",
            "type": "SmsMessage",
            "source": "Manual",
            "isTransactional": false,
            "status": "Delivered",
            "messageLink": "https://myurl.customer.staging.eclub.se/Open/SmsOnline/Show/aOQkxenO1UOPRq84ARQDBB",
            "messageText": "Hej! Välkommen som medlem hos SHOP. Komplettera med samtycke och epost här [[registrationUrl:043223c7-79ee-41d4-8db8-af2a00894f33]]"
        },
        {
            "messageId": "d4afac12-9080-4d17-b009-af11009b9a1a",
            "name": "Testauto",
            "sendDateTime": "2022-09-15T07:26:32+00:00",
            "type": "EmailMessage",
            "source": "Automation",
            "isTransactional": false,
            "status": "Delivered",
            "messageLink": "https://myurl.customer.staging.eclub.se/open/email/online/Eqyv1ICQF02wCa8RAJlejA/n0pgJu8AGkySna8RAHnP8w/8coDxC_inkCP_K8RAJuajA",
            "messageText": "This is a test email."
        }
    ]
}

Note

The field messageLink contains an URL that leads you to a visualization of the message.

Note

The field messageText contains the full text for an SMS, or the subject line if it's an email.

Field definitions

Field name

Type

Description

Example value

messageId

GUID

Unique message id

ea11fa26-54d7-4689-984e-ad4000d7a153

name

string

Name of the message in Voyado

20210610_SE_Summer collection_VIP

sendDateTime

datetime

Date and time when the message was sent with offset

2021-06-100T09:42:44.537+02:00

type

string

Type of message (EmailMessage, SmsMessage or PostalMessage)

EmailMessage

source

string

Where the message was sent from in Voyado Engage (Automation, Manual or System)

Manual

isTransactional

boolean

If the message was sent as transactional or not (does not take opt-in into account)

false

status

string

Delivery status of the send-out

Delivered

messageLink

string

The URL for the web version of the email

https://[client].customer.voyado.com/open/email/online/mun9-f1vQEiZ-K1BAUB68Q/9DGtlvkQyka96qpVAMJ70A/m4L3rBllXEiPea1DALLg3A

messageText

string

The text content of the SMS or the subject line of the email.

Check out our summer collection!