Flush Device Pending Queue
| Property | Description |
| Resource URL | /customer/v1/{customer_id}/messaging/{messaging_profile_id}/flush |
| Method | POST |
| Body | Messaging Flush Object |
Sample Request
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
POST /customer/v1/5a393ea210d91806b7ef702c/messaging/messaging_conn_profile_1001/flush HEADER authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjE1MjIwODg2MzIsImV4cCI6MTUyMjA4ODY0MiwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.mHoao135IAn6mdKpJJAxKVldCsHWZtGtvTn3DuLhDjg { "request_id":"", "request_parameters":{ "device_id":"5a623f4ddd59545193ea9b6c ", "device_name":"", "udid":"", "imsi":"", "device_ip":"", "service_template_id":"", "transaction_id_list":[ ] } } |
Sample Response
|
1 2 3 4 5 |
{ "request_id":"", "result_code":0, "result_description":"Success" } |
Note:
• The flush operation can be used to flush (move) all uplink and downlink messages belonging to a specific device from the pending queue to the shipped queue.
• The device whose message queue is to be flushed can be identified by its: udid or device_id or device_name, imsi or device_ip + service_template_id. When device_name is used all messages belonging to any customer device that is identified by the specified device name are flushed to the shipped queue.
• The transaction_id_list field can be used to specify the specific messages to be flushed by providing the transaction_ids (one or more) of the message records.
• The flush operation can be used to flush (move) all uplink and downlink messages belonging to a specific device from the pending queue to the shipped queue.
• The device whose message queue is to be flushed can be identified by its: udid or device_id or device_name, imsi or device_ip + service_template_id. When device_name is used all messages belonging to any customer device that is identified by the specified device name are flushed to the shipped queue.
• The transaction_id_list field can be used to specify the specific messages to be flushed by providing the transaction_ids (one or more) of the message records.
Flush a specific message from failed queue to shipped queue
| Property | Description |
| Resource URL | /customer/v1/{customer_id}/messaging/{messaging_profile_id}/flush |
| Method | POST |
| Body | Messaging Flush Object |
Sample Request
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
POST /customer/v1/5a393ea210d91806b7ef702c/messaging/messaging_conn_profile_1001/flush HEADER authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjE1MjIwODg2MzIsImV4cCI6MTUyMjA4ODY0MiwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.mHoao135IAn6mdKpJJAxKVldCsHWZtGtvTn3DuLhDjg { "request_id":"", "request_parameters":{ "transaction_id_list":[ "5897a6b07a83380fcc776af4", "5897a23a1876900efcf67ee0" ] } } |
Sample Response
|
1 2 3 4 5 |
{ "request_id":"", "result_code":0, "result_description":"Success" } |
Note:
To flush a message from the “failed” queue to the “shipped” queue the transaction_id of the messages to be flushed must be provided in the transaction_id_list array attribute.
To flush a message from the “failed” queue to the “shipped” queue the transaction_id of the messages to be flushed must be provided in the transaction_id_list array attribute.