Submit a message from your upstream application for onward transmission to the specified device.
The device to transmit the message can be identified using one of the following identifiers (either or):
- udid
- imsi
- device_id
- device_ip + service_template_id
| Property | Description |
| Resource URL | /customer/v1/{customer_id}/messaging/{messaging_profile_id}/submit |
| Method | POST |
| Body | Messaging Submit Object |
Sample Request
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
POST /customer/v1/5a393ea210d91806b7ef702c/messaging/messaging_conn_profile_1001/submit HEADER authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjE1MjIwODg2MzIsImV4cCI6MTUyMjA4ODY0MiwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.mHoao135IAn6mdKpJJAxKVldCsHWZtGtvTn3DuLhDjg { "request_id":"129922929", "customer_id":"5a393ea210d91806b7ef702c", "request_parameters": { "<strong>device_id</strong>" : "gsm1000k55", "service_access_point" : "udp.lon1.sap.iotgtw.com", "device_port" : 5000, "delivery_priority" : 6, "delivery_ack_required" : false, "delivery_method" : "", "delivery_path" : "", "delivery_path_observe" : "", "token_id" : "", "max_queue_duration" : 10, "message_id": "", "payload": { "data": "LwA5AGoALwAAFEAQQBBAEEAUQBBAEIAQQBBAEQALwA" } } } |
Sample Response
|
1 2 3 4 5 6 7 8 |
{ "request_id": "129922929", "result_code": 0, "result_description": "Success - Message Queued (Awaiting Device First Connection)", "response": { "transaction_id": "5c3d106e56c7050b523e4cf5" } } |
Note: The device may also be identified by specifying the device udid or device_id or device sim identifier – imsi (if its a cellular device) or device IP address. If the device IP address is used for device identification then the device associated service_template_id must also be supplied. Some examples:
An Example using UDID (which is automatically generated for every device created)
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
POST /customer/v1/5a393ea210d91806b7ef702c/messaging/messaging_conn_profile_1001/submit HEADER authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjE1MjIwODg2MzIsImV4cCI6MTUyMjA4ODY0MiwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.mHoao135IAn6mdKpJJAxKVldCsHWZtGtvTn3DuLhDjg { "request_id":"129922929", "customer_id":"5a393ea210d91806b7ef702c", "request_parameters": { "<strong>udid</strong>" : "5b2297d87e091748f024482e", "service_access_point" : "udp.lon1.sap.iotgtw.com", "device_port" : 5000, "delivery_priority" : 6, "delivery_ack_required" : false, "delivery_method" : "", "delivery_path" : "", "delivery_path_observe" : "", "token_id" : "", "max_queue_duration" : 10, "message_id": "", "payload": { "data": "LwA5AGoALwAAFEAQQBBAEEAUQBBAEIAQQBBAEQALwA" } } } |
An Example using IMSI (Customer configured SIM card identity for cellular type devices)
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
POST /customer/v1/5a393ea210d91806b7ef702c/messaging/messaging_conn_profile_1001/submit HEADER authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjE1MjIwODg2MzIsImV4cCI6MTUyMjA4ODY0MiwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.mHoao135IAn6mdKpJJAxKVldCsHWZtGtvTn3DuLhDjg { "request_id":"129922929", "customer_id":"5a393ea210d91806b7ef702c", "request_parameters": { "<strong>imsi</strong>" : "204451234567894", "service_access_point" : "udp.lon1.sap.iotgtw.com", "device_port" : 5000, "delivery_priority" : 6, "delivery_ack_required" : false, "delivery_method" : "", "delivery_path" : "", "delivery_path_observe" : "", "token_id" : "", "max_queue_duration" : 10, "message_id": "", "payload": { "data": "LwA5AGoALwAAFEAQQBBAEEAUQBBAEIAQQBBAEQALwA" } } } |
An Example using Device IP (The device service template id must also be specified when using the device IP address to identify the device)
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
POST /customer/v1/5a393ea210d91806b7ef702c/messaging/messaging_conn_profile_1001/submit HEADER authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjE1MjIwODg2MzIsImV4cCI6MTUyMjA4ODY0MiwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.mHoao135IAn6mdKpJJAxKVldCsHWZtGtvTn3DuLhDjg { "request_id":"129922929", "customer_id":"5a393ea210d91806b7ef702c", "request_parameters": { "<strong>device_ip</strong>" : "100.23.67.66", "<strong>service_template_id</strong>" : "my_test_conf_profile1", "service_access_point" : "udp.lon1.sap.iotgtw.com", "device_port" : 5000, "delivery_priority" : 6, "delivery_ack_required" : false, "delivery_method" : "", "delivery_path" : "", "delivery_path_observe" : "", "token_id" : "", "max_queue_duration" : 10, "message_id": "", "payload": { "data": "LwA5AGoALwAAFEAQQBBAEEAUQBBAEIAQQBBAEQALwA" } } } |