Using this API, you can add multiple phone numbers to a Block Number group.

📘
APIs Domain Name
For domestic ccaas - enter the domain: in1-ccaas-api.ozonetel.com
For international ccaas - enter the domain: api.ccaas.ozonetel.com
For Partners - enter the respective URL

👍
Note:
Make sure the admin setting 'API Authentication' is set to 'BASIC_AUTH', If you are using this API.

Header parameters

Parameter	Description
apiKey*	Your CloudAgent account API Key
Content-Type	application/json

Body Params

{
"userName":"xxxx",
"groupName":"xxxx",
"description":"xxxxx",
"expiryDate":"2024-09-10 10:15:12",
"blockNumbers": [
"xxxxxxxxxx",
"xxxxxxxxxx"
][
"xxxxxxxxxx",
"xxxxxxxxxx"
]
}

Parameter	Description
userName	Your CloudAgent account username
groupName	Name of the group to be updated
description	Enter the description for the group
expiryDate	Add the expiry date for the number, this indicates the duration you want the number to remain in the blocked list. Format: YYYY-MM-DD HH:MM:SS
blockNumbers	Phone numbers to be added to the group

❗️
Rate Limit
This API supports the addition of up to 100 phone numbers in a single request.

Possible responses


Passing Invalid 'username' in Authorization	{"status": "error","message": "Authentication failed"}
Passing Invalid 'password' in Authorization	{"status": "error","message": "Authentication failed"}
Passing invalid Idkey parameter.	{ "status": "error","message": "Parameters are mandatory"}
Passing invalid Idvalue parameter.	{ "status": "error","message": "Invalid group id"}
Passing invalid blockNumbers key parameter.	{ "status": "error","message": "Parameters are mandatory"}
Passing invalid blockNumbers value parameter.	{"status": "error","message": "invalid data","errors": {"blockNumbers": "Blocknumbers data contains invalid format of numbers"}}
Successfully updating multiple numbers in a group	"{""status"": ""success"",""message"": ""updated"",""input"": {""id"": XX, ""blockNumbers"": [""97XXX04XX3"", ""97XXX0XX94"",""97XXX0XX95""][""97XXX04XX3"", ""97XXX0XX94"",""97XXX0XX95""]}, ""output"": {""succes"": [ ""+9197XXX04XX3"",""+9197XXX0XX94"", ""+9197XXX0XX95""][ ""+9197XXX04XX3"",""+9197XXX0XX94"", ""+9197XXX0XX95""], ""error"": [],""new"": 3,""inserted"": 3}}"

200Successful response