# Reports
# Get delivery reports (DLR) basic
# Description
You can use this API get Delivery reports.
# Endpoint
POST https://my.textme.co.il/api
# Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| dlr | object | Contains all other elements. | ✔️ |
| user | object | Contains the user element. | ✔️ |
| username | string | The username of the account by which you are recognized in the system | ✔️ |
| transactions | object | Contains all sms destinations you wish to receive DLR’s for. May contain multiple external_id fields. | ✔️ |
| external_id | string | The id you have sent as an attribute while submitted the SMS. | ✔️ |
| from | object | The start date to take DLR’s from. Format : dd/mm/yy hh:mm | ✔️ |
| to | object | The end date to take DLR’s from. Format : dd/mm/yy hh:mm | ✔️ |
Note
- The date range that is allowed to pick from is up to 1 week.
- The max limit of external_id's in each request is 1000.
# Request Example
xml
Copy code
# Response Example
xml
Copy code
Note
Full description of the response status and message can be found in here:
# Get Delivery reports by date(dlrByDate)
# Description
You can use this API to get Delivery reports without external id .
# Endpoint
POST https://my.textme.co.il/api
# Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| dlrbyDate | object | Contains all other elements. | ✔️ |
| user | object | Contains the user element. | ✔️ |
| username | string | The username of the account by which you are recognized in the system | ✔️ |
| transactions | object | Contains all sms destinations you wish to receive DLR’s for. May contain multiple external_id fields. | ✔️ |
| external_id | string | Can contain a value of null . | ✔️ |
| from | object | The start date to take DLR’s from. Format : dd/mm/yy hh:mm | ✔️ |
| to | object | The end date to take DLR’s from. Format : dd/mm/yy hh:mm | ✔️ |
Note
- The date range that is allowed to pick from is up to 1 week.
# Request Example
xml
Copy code
# Response Example
xml
Copy code
Note
Full description of the response status and message can be found in here:
# Get Incoming SMS
# Description
You can use this API to get Incoming reports.
# Endpoint
POST https://my.textme.co.il/api
# Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| incoming | object | Contains all other elements. | ✔️ |
| user | object | Contains the user element. | ✔️ |
| username | string | The username of the account by which you are recognized in the system | ✔️ |
| from | object | The start date to take Incoming’s from. Format : dd/mm/yy hh:mm | ✔️ |
| to | object | The end date to take Incoming’s from. Format : dd/mm/yy hh:mm | ✔️ |
Note
- The date range that is allowed to pick from is a range of 1 week up to 1 year back.
# Request Example
xml
Copy code
# Response Example
xml
Copy code
Note
Full description of the response status and message can be found in here: