Start SMS log export job
POST https://sms.8x8.com/api/v1/subaccounts/:subAccountId/messages/exports
- Sending a POST request on this endpoint allows to request an SMS logs file.
URL
The 8x8 SMS subAccountId needs to be provided in the URL as shown below:
https://sms.8x8.com/api/v1/subaccounts/{subAccountID}/messages/exports
You must replace
{subAccountId}in the URL above with the subaccountid that you want to use.
Request
Path Parameters
Possible values: >= 3 characters and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\-._&]{3,50}$
You must replace {subAccountId} with the subaccountid that you want to use. By default this is generated once you signed up with a new account at https://connect.8x8.com.
Body
- UTC date (
yyyy-MM-ddformat). - UTC timezone datetime, then the expected format is
yyyy-MM-ddTHH:mm:ssZ - or as local timezone datetime, then the expected format is
yyyy-MM-ddTHH:mm:sszzz -
2020-07-01Date without time -
2020-07-01T13:00:00(UTC Time) -
2020-07-01T13:00:00+07:00Datetime with timezone - UTC date (
yyyy-MM-ddformat). - UTC timezone datetime, then the expected format is
yyyy-MM-ddTHH:mm:ssZ - or as local timezone datetime, then the expected format is
yyyy-MM-ddTHH:mm:sszzz -
2020-07-01Date without time -
2020-07-01T13:00:00(UTC Time) -
2020-07-01T13:00:00+07:00Datetime with timezone - NB: a longer time-span (eg: several months) and no limit on the records number will increase the time required to generate the logs file.
The values can be entered either as:
The API will automatically determine whether the datetime is UTC or local based on the format of the value.
The default value is UTC today - 7 days.
The value should less than value of to parameter.
Example values:
The values can be entered either as:
The API will automatically determine whether the datetime is UTC or local based on the format of the value.
The default value is today in UTC timezone.
The value should less than value of to parameter.
Example values:
Valid phone number in E.164 format.
6511111111
The list of two-letter ISO 3166 country codes that the message has been sent to
Possible values: >= 2 characters and <= 2 characters
["US","SG"]
You also need to define if you would like to limit the number of records to fetch using the parameter limit and an integer value
If you do not want to put a limit on the number of records to retrieve, setting limit to 0 allows to set is as unlimited.
Schema
Identifier of the job started. Use this value to query job result.
{
"jobId":"string"
}
{
"jobId":"F1T6z9C5tW2QV1pdMzO9xpMXrYEmfnvqORGqpePJGpgzjTJ80TSaZEE7aX2wrgix"
}
Source: https://developer.8x8.com/connect/reference/reporting-api-2 · 8x8 CPaaS Developer Docs. Synced for support deflection.
0 Comments