Skip to main content
Node.js
import { PeriskopeApi } from '@periskope/periskope-client';

const client = new PeriskopeApi({
  authToken: 'YOUR_API_KEY',
  phone: 'YOUR_PHONE_NUMBER', // e.g., '919876543210'
});

async function getMessage() {
  const response = await client.message.getById({
    message_id: '[email protected]_3EB0F754E67BDF3178E76C680224FF7114E2CB95'
  });

  console.log(response);
}

getMessage();
{}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-phone
string

Please provide the number of the phone you want to call with this API in the header. The number must be in country code + number format without any characters or spaces, e.g. 919876543210; Alternatively, provide the phone_id (phone-xxxxxxxxxxxx) in the header

Example:

"{{orgPhone}}"

Path Parameters

​
message_id
string
required
  • The message_id or the queue_id of the message
  • If the message is still pending in the queue, queue_id will not return a value
Example:

"[email protected]_3EB0C62861626B2D8BD4A386E48976EC85CB009C"

Response

200 - application/json

200 OK

The response is a message object. Refer to the message object here