cdp.connection.batch.update
The cdp.connection.batch.update command is used to update multiple existing connections in one command.
TR50 Request
{
"cmd" : {
"command": "cdp.connection.batch.update",
"params": {
"custom1": "DW0",
"custom2": "DW1",
"custom3": "DW2",
"tags": ["tag3", "tag4"],
"data":[
{
"id": "56asdfqn4bqer12452b2454",
"customer": "QWERTY",
"ratePlan": "10MB Plan",
"status": "activated",
"tags": ["tag1", "tag2"],
"secTags": ["tag1", "tag2"]
},
{
"id": "56asdfqn4bqer12452b2455",
"customer": "QWERTY",
"ratePlan": "10MB Plan",
"status": "activated",
"tags": ["tag1", "tag2"],
"secTags": ["tag1", "tag2"]
},
{
"id": "56asdfqn4bqer12452b2456",
"customer": "QWERTY",
"ratePlan": "10MB Plan",
"status": "activated",
"tags": ["tag1", "tag2"],
"secTags": ["tag1", "tag2"]
},
{
"id": "50000000000000000000000",
"customer": "QWERTY",
"ratePlan": "10MB Plan",
"status": "activated",
"tags": ["tag1", "tag2"],
"secTags": ["tag1", "tag2"]
}
]
}
}
}
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.) | |
ratePlanId | Integer | The rate plan ID to assign to the connection. (Used for Telit IoT Connectivity connections.) | |
status | String | The status that the connection should have. | |
tags | Array | The array of tags the connection should now have. | |
secTags | Array | The array of security tag the connection should now have. | |
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 = 1. |
TR50 Response
If the command is sent successfully a success message is returned showing the count of successful updates, and if there are failures, an array of failure messages. Otherwise, an error and error message will be returned.
{
"cmd": {
"success": true
"params": {
"count": 3,
"failures": [
"CDP connection with id '500000000000000000000000' not found."
]
}
}
}