Get Campaigns by Number (Token Auth)

Returns the list of campaigns in which the given phone numbers are currently added.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

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

To use this API with the help of a token, follow these steps:

  1. Generate the Token: Use the 'Generate Token' API to obtain an authentication token.
  2. Enter the Token ID: Navigate to the right section of this page, under the 'AUTHORIZATION' tab. Here, input the generated token ID.
  3. With the token entered, pass the header and body parameters:
❗️

Rate Limit:

  • The API supports 1 request per minute, with a maximum of 100 phone numbers per request.

Possible Responses

Success Response

{

"status": "success","data": [{"LeadStatus": "Fail","CampaignName": "Preview-dynamic","PhoneNumber": "99xxxxx3","LeadNumber": 54xxx89},{"LeadStatus": "FreshLead","CampaignName": "Preview-dynamic",
"PhoneNumber": "9xxxxx3",
"LeadNumber": 54376090
},
{
"LeadNumber": 54376093,
"LeadStatus": "FreshLead",
"CampaignName": "Preview-dynamic",
"PhoneNumber": "9xxxx3"
},
{
"LeadStatus": "FreshLead",
"CampaignName": "Preview-dynamic",
"LeadNumber": 54376094,
"PhoneNumber": "9xxxx3"
}
],
"message": "success"
}

Passing Invalid Token Value{""status"": ""false"",""message"": ""Invalid Token"",
""data"": null}
Missing Token Value{"status": "false","message": "Token Should Not be Null or Empty.","data": null}
Passing expired Token{"status": "false","message": "Token Expired","data": null}
Passing Invalid userName Value{"status": "false","message": "Invalid User Details","data": null}
Missing userName Value{""status"": ""false"",""message"": ""Username Should Not be Null or Empty.",
"data": null}
Passing Invalid phoneNumber Value{ ""status"": ""success"",
""data"": [],
""message"": ""success"" }
Missing phoneNumber ValuephoneNumber Should Not be Null or Empty.
More than 10 hits per minute{ ""status"": ""Error"",
""message"": ""Max limit exceeded"" }
Body Params
string
required

CloudAgent account name

string
required

Comma-separated phone numbers to lookup

Response

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json