Sign in
latestSwagger 2.02026-08-101561322.2 MB

3e4029d19684

Outbound Message Sessions

Get a session`s details

<a class="try-sandbox-link" href="https://sandbox.textmagic.com/#/Sessions/getMessageSession" target="_blank">Try in sandbox</a><br>Get a specific session’s details.

get/api/v2/sessions/{id}

Path parameters

idinteger required

Session ID.

Response

Returned when successful.

idinteger required

Session ID.

startTimestring nullable required

Session creation time.

textstring nullable required

Session text. If a template was used for the session text (see Messages: Send for details), it may contain template tags.

sourcestring nullable required
referenceIdstring nullable required

Custom reference ID (see Messages: Send for details).

pricenumber nullable required

Session cost (in account currency).

numbersCountinteger nullable required

Session recipient count.

destination't' | 's' | 'v' nullable required

Destination type of a Message Session:

  • t – text SMS;
  • s – text-to-speech;
  • v – voice broadcast.
initiatorIdinteger nullable required

Initiator ID.

titlestring nullable required

Example response

{
  "id": 4991,
  "startTime": "2015-06-19T09:48:24+0000",
  "text": "Hello {First name}!",
  "source": "O",
  "referenceId": "my_reference_id_4991",
  "price": 3.45,
  "numbersCount": 18,
  "destination": "t",
  "initiatorId": 305
}