Sign in
latestSwagger 2.02026-08-101561322.2 MB

3e4029d19684

Outbound Messages

Get bulk session status

<a class="try-sandbox-link" href="https://sandbox.textmagic.com/#/Messages%3A%20Send%0A/getBulkSession" target="_blank">Try in sandbox</a><br>

get/api/v2/bulks/{id}

Path parameters

idinteger required

Response

Returned when successful.

idinteger required

Bulk Session ID.

status'n' | 'w' | 'f' | 'c' | 's' required
  • n – bulk session is just created
  • w - work in progress
  • f - failed
  • c - completed with success
  • s - suspended
itemsProcessedinteger nullable required

Amount of messages already processed.

itemsTotalinteger nullable required

Total amount of messages to be processed.

createdAtstring date-time required

Creation date and time of a Bulk Session.

textstring nullable required

Message text of a Bulk Session.

Example response

{
  "id": 599,
  "status": "n",
  "itemsProcessed": 564,
  "itemsTotal": 2,
  "createdAt": "2015-01-08T06:13:21+0000",
  "session": {
    "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
  },
  "text": "I Love Textmagic!"
}