GetSmsHistory

POST

https://api.voximplant.com/platform_api/GetSmsHistory

POST

/platform_api/GetSmsHistory

curl -X POST https://api.voximplant.com/platform_api/GetSmsHistory \
     -H "Authorization: Bearer <token>"

200Example 1

{
  "result": [
    {
      "message_id": 1,
      "source_number": "12345678111",
      "destination_number": "12345678222",
      "direction": "IN",
      "fragments": 1,
      "cost": 4.3437,
      "status_id": "2",
      "error_message": "Some error message text here",
      "processed_date": "2019-03-11 21:00:00",
      "transaction_id": 12,
      "text": "Hi!"
    },
    {
      "message_id": 3,
      "source_number": "12345678111",
      "destination_number": "12345678222",
      "direction": "IN",
      "fragments": 1,
      "cost": 2.7123,
      "status_id": "1",
      "processed_date": "2019-06-04 21:00:00",
      "transaction_id": 3333,
      "text": "Sup?"
    }
  ],
  "total_count": 2
}

Gets the history of sent and/or received SMS.

Allowed roles: Owner, Admin, Developer, Supervisor, Accountant, CallsSMS.

Example request: Get messages that had been sent to number 12345678222 starting from March 1, 2019. Number of resulting rows is limited to 2.

Authentication

AuthorizationBearer

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Query parameters

source_numberstringOptional

The source phone number

destination_numberstringOptional

The destination phone number

directionstringOptional

Sent or received SMS. Possible values: 'IN', 'OUT', 'in, 'out'. Leave blank to get both incoming and outgoing messages

countintegerOptional

Maximum number of resulting rows fetched. Must be not bigger than 1000. If left blank, then the default value of 1000 is used

offsetintegerOptional

The first N records are skipped in the output

from_datestringOptional

Date from which to perform search. Format is 'yyyy-MM-dd HH:mm:ss', time zone is UTC

to_datestringOptional

Date until which to perform search. Format is 'yyyy-MM-dd HH:mm:ss', time zone is UTC

outputstringOptionalDefaults to json

The output format. The following values available: json, csv, xls. The default value is json

Response

Successful response

resultlist of objectsOptional

total_countintegerOptional

Total number of messages matching the query parameters