Apply set of configurations to one or many DIDs
POST {{baseUrl}}/v1/configuration/bulk
Request Body
{"didIds"=>["<integer>", "<integer>"], "voiceUriId"=>"<string>", "smsLinkGroupId"=>"<string>", "faxUriId"=>"<integer>", "voxFaxEnabled"=>"<boolean>", "capacityGroupId"=>"<string>", "trunkId"=>"<string>", "deliveryId"=>"<string>", "srvLookup"=>"<boolean>", "callerId"=>{"cliFormat"=>"<string>", "cliValue"=>"<string>"}, "cliPrivacy"=>"<string>", "peer"=>{"t38Enabled"=>"<string>", "dtmf"=>"<string>", "dtmfInbandMute"=>"<string>", "codecs"=>["<string>", "<string>"]}, "ringback"=>"<string>", "dnisEnabled"=>"<boolean>", "blockOrdinary"=>"<boolean>", "blockCellular"=>"<boolean>", "blockPayphone"=>"<boolean>", "smsOutbound"=>"<boolean>", "webRtcEnabled"=>"<boolean>", "limitChannels"=>"<integer>", "limitChannelsOutbound"=>"<number>", "voxoutInternationalEnabled"=>"<boolean>", "voxoutNationalEnabled"=>"<boolean>"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
apikey | string | Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help. | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"success":1,"error":0,"partial":6,"total":7,"results":[{"didId":928818,"status":"PARTIAL","updatedConfigurations":["VOICE_URI","CAPACITY_GROUP","SIP_DELIVERY","RING_BACK","CHANNELS_LIMMIT","VOXOUT_NATIONAL"],"partialConfigurations":["TRUNK","SMS_OUTBOUND_ENABLED"],"messages":[{"configuration":"TRUNK","description":"Trunk is invalid or zoneProduct is not supported"},{"configuration":"SMS_OUTBOUND_ENABLED","description":"Sms is not supported"}]},{"didId":3644928,"status":"PARTIAL","updatedConfigurations":["VOICE_URI","CAPACITY_GROUP","TRUNK","SIP_DELIVERY","RING_BACK","CHANNELS_LIMMIT","VOXOUT_NATIONAL"],"partialConfigurations":["SMS_OUTBOUND_ENABLED"],"messages":[{"configuration":"SMS_OUTBOUND_ENABLED","description":"Sms is not supported"}]},{"didId":3644929,"status":"PARTIAL","updatedConfigurations":["VOICE_URI","CAPACITY_GROUP","TRUNK","SIP_DELIVERY","RING_BACK","CHANNELS_LIMMIT","VOXOUT_NATIONAL"],"partialConfigurations":["SMS_OUTBOUND_ENABLED"],"messages":[{"configuration":"SMS_OUTBOUND_ENABLED","description":"Sms is not supported"}]},{"didId":5807022,"status":"PARTIAL","updatedConfigurations":["VOICE_URI","CAPACITY_GROUP","TRUNK","SIP_DELIVERY","RING_BACK","SMS_OUTBOUND_ENABLED","CHANNELS_LIMMIT"],"partialConfigurations":["VOXOUT_NATIONAL"],"messages":[{"configuration":"VOXOUT_NATIONAL","description":"VoxOut National cannot be activated on this number. Please contact support for more details."}]},{"didId":5807023,"status":"PARTIAL","updatedConfigurations":["VOICE_URI","CAPACITY_GROUP","TRUNK","SIP_DELIVERY","RING_BACK","SMS_OUTBOUND_ENABLED","CHANNELS_LIMMIT"],"partialConfigurations":["VOXOUT_NATIONAL"],"messages":[{"configuration":"VOXOUT_NATIONAL","description":"VoxOut National cannot be activated on this number. Please contact support for more details."}]},{"didId":9475529,"status":"PARTIAL","updatedConfigurations":["VOICE_URI","CAPACITY_GROUP","TRUNK","SIP_DELIVERY","RING_BACK","CHANNELS_LIMMIT"],"partialConfigurations":["VOXOUT_NATIONAL","SMS_OUTBOUND_ENABLED"],"messages":[{"configuration":"VOXOUT_NATIONAL","description":"VoxOut National cannot be activated on this number. Please contact support for more details."},{"configuration":"SMS_OUTBOUND_ENABLED","description":"Sms is not supported"}]},{"didId":6484442,"status":"SUCCESS","updatedConfigurations":["VOICE_URI","CAPACITY_GROUP","TRUNK","SIP_DELIVERY","RING_BACK","SMS_OUTBOUND_ENABLED","CHANNELS_LIMMIT","VOXOUT_NATIONAL"]}]}