cdp.connection.update
The cdp.connection.update command is used to update the parameters of an existing connection.
You will experience a delay while using cdp.connection.update, especially while updating status and ratePlan parameters. When status or ratePlan is changed, the CDP needs to authorize and synchronize the update for the change to appear. Sometimes, it will take up to 24 hours to view the change, but can be hasten by forcing a refresh of the connection.
TR50 Request
{
"cmd" : {
"command": "cdp.connection.update",
"params": {
"id": "56asdfqn4bqer12452b2454",
"customer": "QWERTY",
"ratePlan": "10MB Plan",
"status": "activated",
"tags": ["tag1", "tag2"],
"secTags": ["tag1", "tag2"],
"unset": ["desc", "tags", "terminalId", "ratePlanId", "secTags"]
}
}
}
Request Parameters
Do not include the fields that are fixed in the params object.
Name | Type | Required | Description |
---|---|---|---|
id | String | Yes* | The id of the connection to be updated. |
esn | String | ESN of the connection. | |
iccid | String | ICCID of the connection. | |
imei | String | IMEI of the connection. | |
imsi | String | IMSI of the connection. | |
meid | String | MEID of the connection. | |
msisdn | String | MSISDN of the connection. | |
thingKey | String | The identifier of the thing that the connection is related to. | |
thingId | String | The identifier of the thing that the connection is related to. | |
*One of the above parameters is required to identify the connection. | |||
terminalId | String | The terminalId to assign to the connection. | |
custom1-4 | String | The custom1, custom2, custom3 and custom4 fields represent optional values to assign to the connection. | |
customer | String | The customer to assign to the connection. | |
carrierCustom1-4 | String | The carrierCustom1, carrierCustom2, carrierCustom3 and carrierCustom4 fields represent optional values assigned by the carrier to the connection. | |
ratePlan | String | The rate plan to assign to the connection. (Used for Jasper connections.) ratePlan is custom to a CDP. For more information, contact Technical Support. |
|
ratePlanId | Integer | The rate plan ID to assign to the connection. (Used for Telit IoT Connectivity connections.) | |
status | String | The status of a connection. The options includes:
The above options are translated to CDP specific values. Some of these options may not work for a CDP as it might not contain the corresponding value and a particular CDP may have additional options. For more information, contact Technical Support. |
|
tags | Array | The array of tags the connection should now have. | |
secTags | Array | The array of security tag the connection should now have. | |
unset | Array | An array of fields to unset. All optional parameters are allowed to be unset. | |
services.data.current | Integer | Enable or Disable SIM's cellular data: Disable = 0, Enable = 1. | |
services.sms.current | Integer | Enable or Disable SIM's SMS: Disable = 0, MO =1, MT = 2, Both = 3. | |
services.voice.current | Integer | Enable or Disable SIM's voice communications: Disable = 0, Enable = 2. |
TR50 Response
If the command is sent successfully a success message is returned. Otherwise, an error and error message will be returned.
{
"cmd": {
"success": true
}
}