2. Home
  4. Docs
  6. IoTGtw API Samples
  8. Provisioning API (Manage Account, Devices, Service Templates, Endpoint Profiles)
  10. MessagingEndpoint

MessagingEndpoint

List Messaging Endpoint Profiles created by customer user on the account
Property Description
Resource URL /customer/v1/{customer_id} /service_provisioning/messagingEndpoints
Method GET
Body None
Sample Request

Messaging Endpoint
1
2
3
4
GET /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/messagingEndpoints
 
HEADER
authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw

Sample Response

Messaging Endpoint
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
{  
   "request_id":"",
   "result_code":0,
   "result_description":"Success",
   "response":[  
      {  
         "messaging_endpoint_id":"fleet20_downlink_only_profile",
         "state":true,
         "target_application":"IoTGtw_Application_RESTful",
         "inbound_messaging":{  
            "permitted_ip_list":[  
 
            ],
            "enable_ip_validation":false,
            "jwt_api_key":"8pZZEPp5Nna2KUwuqkEzdF4HLK3NqR2cZgACukUw",
            "bearer_token":"",
            "password":"",
            "username":"",
            "auth_type":"jwt_hmac_shared_secret"
         },
         "outbound_messaging":{  
            "endpoint":"",
            "jwt_api_key":"",
            "bearer_token":"",
            "password":"",
            "username":"",
            "auth_type":"jwt_hmac_shared_secret"
         },
         "outbound_notification":{  
            "endpoint":"",
            "jwt_api_key":"",
            "bearer_token":"",
            "password":"",
            "username":"",
            "auth_type":"jwt_hmac_shared_secret"
         },
         "socket_proxy_service_router":[  
 
         ]
      },
      {  
         "messaging_endpoint_id":"my_rest_api_instances",
         "state":true,
         "target_application":"Customer_Application_RESTful",
         "inbound_messaging":{  
            "permitted_ip_list":[  
 
            ],
            "enable_ip_validation":false,
            "jwt_rsa_key":"",
            "jwt_api_key":"r97eTAp2E4fXb7ZpJX3sjFZAagfsqAxgtnwgeTJM8E",
            "bearer_token":"",
            "password":"",
            "username":"",
            "auth_type":"jwt_hmac_shared_secret"
         },
         "outbound_messaging":{  
            "endpoint":"https://www.myawsinstance.com/api/upstream/msg/",
            "permitted_ip_list":[  
 
            ],
            "enable_ip_validation":false,
            "jwt_rsa_key":"",
            "jwt_api_key":"4b7eCS72f5dca54f19925e456e264315135F5c58Da8",
            "bearer_token":"",
            "password":"",
            "username":"",
            "auth_type":"jwt_hmac_shared_secret"
         },
         "outbound_notification":{  
            "endpoint":"https://www.myawsinstance.com/api/upstream/ntf/",
            "permitted_ip_list":[  
 
            ],
            "enable_ip_validation":false,
            "jwt_rsa_key":"",
            "jwt_api_key":"uE4GwmX3cVTLDP5asJxpmz4jgrtp74DYdePqtFQv",
            "bearer_token":"",
            "password":"",
            "username":"",
            "auth_type":"jwt_hmac_shared_secret"
         },
         "socket_proxy_service_router":[  
 
         ]
      },
      {  
         "messaging_endpoint_id":"my_aws_tcp_instances1",
         "state":true,
         "target_application":"Customer_Application_TCP_Server",
         "inbound_messaging":{  
 
         },
         "outbound_messaging":{  
 
         },
         "outbound_notification":{  
 
         },
         "socket_proxy_service_router":[  
            {  
               "protocol":"tcp",
               "state":true,
               "customer_application_port":4300,
               "customer_application_host":"200.10.200.10",
               "device_app_protocol":"coap",
               "content_type":"",
               "device_listening_port":2100,
               "service_access_point":" faniot",
               "max_queue_duration":15,
               "token_id":"",
               "delivery_path_observe":false,
               "delivery_path":"",
               "delivery_encoding":"",
               "delivery_method":"",
               "delivery_ack_required":false,
               "delivery_priority":5
            }
         ]
      },
      {  
         "messaging_endpoint_id":"udp_upstream_instances_g1",
         "state":true,
         "target_application":"Customer_Application_UDP_Server",
         "inbound_messaging":{  
            "permitted_ip_list":[  
 
            ],
            "enable_ip_validation":false,
            "jwt_rsa_key":"",
            "jwt_api_key":" d5bzfBJFA9yQCtUDySx4weRWsZGXHekT6tV96gMa ",
            "bearer_token":"",
            "password":"",
            "username":"",
            "auth_type":"jwt_hmac_shared_secret"
         },
         "outbound_messaging":{  
 
         },
         "outbound_notification":{  
 
         },
         "socket_proxy_service_router":[  
            {  
               "protocol":"udp",
               "state":true,
               "customer_application_port":3300,
               "customer_application_host":"200.10.200.10",
               "device_app_protocol":"coap",
               "content_type":"",
               "device_listening_port":2600,
               "service_access_point":" doodle",
               "max_queue_duration":15,
               "token_id":"",
               "delivery_path_observe":false,
               "delivery_path":"",
               "delivery_encoding":"",
               "delivery_method":"",
               "delivery_ack_required":false,
               "delivery_priority":5
            }
         ]
      }
   ]
}

List a specific Messaging Endpoint Profile
Property Description
Resource URL /customer/v1/{customer_id} /service_provisioning/messagingEndpoints/{message_endpoint_id}
Method GET
Body None
Sample Request

Messaging Endpoint
1
2
3
4
GET /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/messagingEndpoints/my_aws_tcp_instances1
 
HEADER
authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw

Sample Response

Messaging Endpoint
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
27
28
29
30
31
32
33
34
35
36
37
38
39
{  
   "request_id":"",
   "result_code":0,
   "result_description":"Success",
   "response":{  
      "messaging_endpoint_id":"my_aws_tcp_instances1",
      "state":true,
      "target_application":"Customer_Application_TCP_Server",
      "inbound_messaging":{  
 
      },
      "outbound_messaging":{  
 
      },
      "outbound_notification":{  
 
      },
      "socket_proxy_service_router":[  
         {  
            "protocol":"tcp",
            "state":true,
            "customer_application_port":4300,
            "customer_application_host":"200.10.200.10",
            "device_app_protocol":"coap",
            "content_type":"",
            "device_listening_port":2100,
            "service_access_point":" faniot",
            "max_queue_duration":15,
            "token_id":"",
            "delivery_path_observe":false,
            "delivery_path":"",
            "delivery_encoding":"",
            "delivery_method":"",
            "delivery_ack_required":false,
            "delivery_priority":5
         }
      ]
   }
}

Create a new Messaging Endpoint Profile
Property Description
Resource URL /customer/v1/{customer_id} /service_provisioning/messagingEndpoints/
Method POST
Body Messaging endpoint profile object
Sample Request

Messaging Endpoint
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
GET /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/messagingEndpoints/
 
HEADER
authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw
 
{  
   "request_id":"",
   "request_parameters":{  
      "messaging_endpoint_id":"external_application_iot_fleet_5",
      "state":true,
      "target_application":"Customer_Application_RESTful",
      "inbound_messaging":{  
         "permitted_ip_list":[  
            "180.90.45.22.",
            "190.90.9.1"
         ],
         "enable_ip_validation":true,
         "jwt_rsa_key":"",
         "jwt_api_key":"ZQjp74UvgpVHv6C2eD2qYvaC95epSwwTKc28HHX3",
         "bearer_token":"",
         "password":"",
         "username":"",
         "auth_type":"jwt_hmac_shared_secret"
      },
      "outbound_messaging":{  
         "endpoint":"https://my_digitalocean_instance.io/messaging_uplink/v1/",
         "permitted_ip_list":[  
 
         ],
         "enable_ip_validation":false,
         "jwt_rsa_key":"",
         "jwt_api_key":"",
         "bearer_token":"",
         "password":"BsbZUwF5xReK5JyYtPN",
         "username":"YuevbJz3TRKUF8EV",
         "auth_type":"basic_auth"
      },
      "outbound_notification":{  
         "endpoint":"https://my_digitalocean_instance.io/notification_uplink/v1/",
         "permitted_ip_list":[  
 
         ],
         "enable_ip_validation":false,
         "jwt_rsa_key":"",
         "jwt_api_key":"",
         "bearer_token":"hmSAV7gw2hMz2X6jDJVux7EJh3CksWEZuDEzDtzmhmSAV7gw2hMz2X6jDJVux7EJh3CksWEZuDEzDtzm",
         "password":"",
         "username":"",
         "auth_type":"bearer_token"
      }
   }
}

Sample Response

Messaging Endpoint
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
{  
   "request_id":"",
   "result_code":0,
   "result_description":"Success",
   "response":{  
      "messaging_endpoint_id":"external_application_iot_fleet_5",
      "state":true,
      "target_application":"Customer_Application_RESTful",
      "inbound_messaging":{  
         "permitted_ip_list":[  
            "180.90.45.22.",
            "190.90.9.1"
         ],
         "enable_ip_validation":true,
         "jwt_rsa_key":"",
         "jwt_api_key":"ZQjp74UvgpVHv6C2eD2qYvaC95epSwwTKc28HHX3",
         "bearer_token":"",
         "password":"",
         "username":"",
         "auth_type":"jwt_hmac_shared_secret"
      },
      "outbound_messaging":{  
         "endpoint":"https://my_digitalocean_instance.io/messaging_uplink/v1/",
         "permitted_ip_list":[  
 
         ],
         "enable_ip_validation":false,
         "jwt_rsa_key":"",
         "jwt_api_key":"",
         "bearer_token":"",
         "password":"BsbZUwF5xReK5JyYtPN",
         "username":"YuevbJz3TRKUF8EV",
         "auth_type":"basic_auth"
      },
      "outbound_notification":{  
         "endpoint":"https://my_digitalocean_instance.io/notification_uplink/v1/",
         "permitted_ip_list":[  
 
         ],
         "enable_ip_validation":false,
         "jwt_rsa_key":"",
         "jwt_api_key":"",
         "bearer_token":"hmSAV7gw2hMz2X6jDJVux7EJh3CksWEZuDEzDtzmhmSAV7gw2hMz2X6jDJVux7EJh3CksWEZuDEzDtzm",
         "password":"",
         "username":"",
         "auth_type":"bearer_token"
      },
      "create_time":"2014-01-19T00:12:23.086Z",
      "socket_proxy_service_router":[  
         {  
            "state":false,
            "protocol":"udp",
            "customer_application_host":"",
            "customer_application_port":0,
            "service_access_point":"",
            "device_listening_port":0,
            "content_type":"",
            "device_app_protocol":"",
            "delivery_priority":5,
            "delivery_ack_required":false,
            "delivery_method":"",
            "delivery_encoding":"",
            "delivery_path":"",
            "delivery_path_observe":false,
            "token_id":"",
            "max_queue_duration":15
         }
      ]
   }
}

Update a Messaging Endpoint Profile
Property Description
Resource URL /customer/v1/{customer_id} /service_provisioning/messagingEndpoints/
Method PUT
Body Messaging endpoint profile object
Sample Request

Messaging Endpoint
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
27
28
29
30
31
32
33
34
GET /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/messagingEndpoints/
 
HEADER
authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw
 
 
{  
   "request_id":"",
   "request_parameters":{  
      "messaging_endpoint_id":"my_aws_tcp_instances1",
      "state":true,
      "target_application":"IoTGtw_Application_RESTful",
      "inbound_messaging":{  
         "auth_type":"jwt_hmac_shared_secret",
         "username":"",
         "password":"",
         "bearer_token":"",
         "jwt_api_key":"ZQjp74UvgpVHv6C2eD2qYvaC95epSwwTKc28HHX3",
         "enable_ip_validation":false,
         "permitted_ip_list":[  
 
         ]
      },
      "outbound_messaging":{  
 
      },
      "outbound_notification":{  
 
      },
      "socket_proxy_service_router":[  
 
      ]
   }
}

Sample Response

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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
{  
   "request_id":"",
   "result_code":0,
   "result_description":"Success",
   "response":{  
      "messaging_endpoint_id":"external_application_iot_fleet_5",
      "state":true,
      "target_application":"Customer_Application_RESTful",
      "inbound_messaging":{  
         "permitted_ip_list":[  
 
         ],
         "enable_ip_validation":false,
         "jwt_rsa_key":"",
         "jwt_api_key":"ZQjp74UvgpVHv6C2eD2qYvaC95epSwwTKc28HHX3",
         "bearer_token":"",
         "password":"",
         "username":"",
         "auth_type":"jwt_hmac_shared_secret"
      },
      "outbound_messaging":{  
         "endpoint":"https://my_digitalocean_instance.io/messaging_uplink/v1/",
         "permitted_ip_list":[  
 
         ],
         "enable_ip_validation":false,
         "jwt_rsa_key":"",
         "jwt_api_key":"",
         "bearer_token":"",
         "password":"BsbZUwF5xReK5JyYtPN",
         "username":"YuevbJz3TRKUF8EV",
         "auth_type":"basic_auth"
      },
      "outbound_notification":{  
         "endpoint":"https://my_digitalocean_instance.io/notification_uplink/v1/",
         "permitted_ip_list":[  
 
         ],
         "enable_ip_validation":false,
         "jwt_rsa_key":"",
         "jwt_api_key":"",
         "bearer_token":"hmSAV7gw2hMz2X6jDJVux7EJh3CksWEZuDEzDtzmhmSAV7gw2hMz2X6jDJVux7EJh3CksWEZuDEzDtzm",
         "password":"",
         "username":"",
         "auth_type":"bearer_token"
      },
      "socket_proxy_service_router":[  
         {  
            "state":false,
            "protocol":"udp",
            "customer_application_host":"",
            "customer_application_port":0,
            "service_access_point":"",
            "device_listening_port":0,
            "content_type":"",
            "device_app_protocol":"",
            "delivery_priority":5,
            "delivery_ack_required":false,
            "delivery_method":"",
            "delivery_encoding":"",
            "delivery_path":"",
            "delivery_path_observe":false,
            "token_id":"",
            "max_queue_duration":15
         }
      ]
   }
}

Delete Messaging Endpoint Profile
Property Description
Resource URL /customer/v1/{customer_id}/service_provisioning/messagingEndpoints/{message_endpoint_id}
Method DELETE
Body None
Sample Request

Messaging Endpoint
1
2
3
4
DELETE /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/messagingEndpoints/my_aws_tcp_instances1
 
HEADER
authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw

Sample Response

1
2
3
4
5
6
{  
   "request_id":"",
   "result_code":0,
   "result_description":"Success",
   "response":""
}

Was this article helpful to you? Yes No

How can we help?