Ozonetel Campaign API

The Campaign API from Ozonetel — 4 operation(s) for campaign.

Operations 4

POST /ca_apis/AddCampaignData Add Campaign Data (Basic Authentication) #
POST /AddCampaignDataBulkV4 Add Campaign Bulk Data V2 #
POST /ca_apis/campaigns/lookup/phoneNumber Lookup Campaigns by Phone Number #
POST /APIServices/campaignControl/outbound Create Outbound Campaign #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/ozonetel:ozonetel-campaign-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

ozonetel-campaign-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Ozonetel Campaign API
  version: 1.0.0
  description: 'Operations tagged Campaign across 4 of this provider''s published API definitions: ozonetel-add-campaign-data-basic-authentication-api-openapi.yml, ozonetel-add-campaign-data-bulk-v4-api-openapi.yml, ozonetel-campaign-phone-number-lookup-basic-auth-api-openapi.yml, ozonetel-create-outbound-campaign-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{domainname}/
  description: The production API server
  variables:
    username:
      default: in1-ccaas-api.ozonetel.com
- url: https://{domainname}/ca_apis
  description: API server
  variables:
    domainname:
      default: in1-ccaas-api.ozonetel.com
tags:
- name: Campaign
paths:
  /ca_apis/AddCampaignData:
    post:
      tags:
      - Campaign
      summary: Add Campaign Data (Basic Authentication)
      description: Adds campaign data, including campaign details and associated metadata.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                campaignName:
                  type: string
                  description: Name of the campaign where the data is to be added.
                  example: PromoCampaign
                phoneNumber:
                  type: string
                  description: The phone number to be added.
                  example: 830xxxxxxx
                name:
                  type: string
                  description: Optional name of the lead. Could be any of your choice.
                  example: John Doe
                action:
                  type: string
                  description: The action to be performed. Pass 'start' to start campaign after data is added.
                  example: start
                skill:
                  type: string
                  description: Associated skill name.
                  example: Sales
                priority:
                  type: integer
                  minimum: 1
                  maximum: 99
                  description: Priority of the number. Higher values are dialed sooner (1-99).
                  example: 10
                agentId:
                  type: string
                  description: Agent ID, if agent-wise campaign.
                  example: Agent001
                expiryDate:
                  type: string
                  format: date-time
                  description: Expiry date of the lead in YYYY-MM-DD HH:MM:SS format.
                  example: '2025-01-01 12:00:00'
                checkDuplicate:
                  type: boolean
                  description: Pass true to check for duplicate phone numbers.
                  example: true
                userName:
                  type: string
                  description: Your CloudAgent account username.
                  example: xxxx
                skipNameFieldValidation:
                  type: boolean
                  description: Pass true to skip name field validation.
                  example: false
                CustomFields1:
                  type: string
                  description: Custom field 1 for additional data.
                  example: xxxx
                CustomFields2:
                  type: string
                  description: Custom field 2 for additional data.
                  example: xxxx
                CustomFields3:
                  type: string
                  description: Custom field 3 for additional data.
                  example: xxxx
              required:
              - campaignName
              - phoneNumber
              - userName
      parameters:
      - name: apiKey
        in: header
        required: true
        schema:
          type: string
        description: API key available from CloudAgent admin panel.
        example: KKxxxxxxx
      - name: Content-Type
        in: header
        required: true
        schema:
          type: string
        example: application/json
        description: Should be set to application/json.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              example:
                status: success
                message: Campaign data added successfully.
      operationId: postCaApisAddCampaignData
      x-operation-id-source: derived
    servers:
    - url: https://{domainname}/
      description: The production API server
      variables:
        username:
          default: in1-ccaas-api.ozonetel.com
  /AddCampaignDataBulkV4:
    post:
      tags:
      - Campaign
      summary: Add Campaign Bulk Data V2
      operationId: addCampaignDataBulkV4
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - campaignName
              - userName
              - bulkData
              properties:
                campaignName:
                  type: string
                  example: PreviewAgentWise54_BULKDATAV4
                skipNameFieldValidation:
                  type: string
                  enum:
                  - 'true'
                  - 'false'
                  example: 'false'
                userName:
                  type: string
                  example: xxxxx
                action:
                  type: string
                  example: start
                checkDuplicate:
                  type: string
                  enum:
                  - 'true'
                  - 'false'
                  example: 'true'
                isDelete:
                  type: string
                  enum:
                  - 'true'
                  - 'false'
                  example: 'false'
                callBackUrl:
                  type: string
                  example: https://your-domain.com/callback
                bulkData:
                  type: string
                  example: '{"map":["PhoneNumber","AgentId","Name"],"data":[["99xxxxxxx5","agent_id","Test1"],["99xxxxxxx6","agent_id","Test2"]]}'
      parameters:
      - name: apiKey
        in: header
        required: true
        schema:
          type: string
        example: KKxxxxxxx
      - name: Content-Type
        in: header
        required: true
        schema:
          type: string
        example: application/json
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
      x-internal: false
    servers:
    - url: https://{domainname}/ca_apis
      description: API server
      variables:
        domainname:
          default: in1-ccaas-api.ozonetel.com
  /ca_apis/campaigns/lookup/phoneNumber:
    post:
      tags:
      - Campaign
      summary: Lookup Campaigns by Phone Number
      description: Returns the list of campaigns in which the given phone numbers are currently added.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                userName:
                  type: string
                  description: CloudAgent account name
                  example: xxxx
                phoneNumber:
                  type: string
                  description: Comma-separated phone numbers to lookup
                  example: 99xxxxx3,85xxxxxx3
              required:
              - userName
              - phoneNumber
      parameters:
      - name: apiKey
        in: header
        required: true
        schema:
          type: string
        description: CloudAgent API Key
      - name: Content-Type
        in: header
        required: true
        schema:
          type: string
        example: application/json
        description: Should be application/json
      responses:
        '200':
          description: Successful lookup
          content:
            application/json:
              example:
                status: success
                message:
                - Position: READY
                  CampaignID: 2
                  DID: 91xxxxx9
                  Campaign: Progressive_91xxx9
                  UserName: xxx
                  CampaignType: Progressive
                - Position: RUNNING
                  CampaignID: 3
                  DID: 91xxxxx9
                  Campaign: In_Txxxxa
                  UserName: xxx
                  CampaignType: InBound
      operationId: postCaApisCampaignsLookupPhoneNumber
      x-operation-id-source: derived
    servers:
    - url: https://{domainname}/
      description: The production API server
      variables:
        domainname:
          default: in1-ccaas-api.ozonetel.com
  /APIServices/campaignControl/outbound:
    post:
      summary: Create Outbound Campaign
      tags:
      - Campaign
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                username:
                  type: string
                campaignName:
                  type: string
                apiKey:
                  type: string
                action:
                  type: string
                campaignType:
                  type: string
                dialMethod:
                  type: string
                did:
                  type: string
                fallbackDID:
                  type: string
                dynamicDID:
                  type: string
                fallbackDynamicDID:
                  type: string
                runtimeStart:
                  type: string
                runtimeEnd:
                  type: string
                mappingName:
                  type: string
                pacingRatio:
                  type: string
                maxDropRatio:
                  type: integer
                maxConcurrentCalls:
                  type: string
                appURL:
                  type: string
                noOfTries:
                  type: string
                priority:
                  type: string
                dialInterval:
                  type: string
                customerRingingTime:
                  type: string
                users:
                  type: string
                urlToPush:
                  type: string
                hitScreenpopURLAt:
                  type: string
                screenPopUrl:
                  type: string
                pluginName:
                  type: string
                callPrefix:
                  type: string
                playDisclaimerURL:
                  type: string
                holdMusic:
                  type: string
                transferMusic:
                  type: string
                dispositions:
                  type: string
                dispositionType:
                  type: string
                wrapUpTime:
                  type: string
                blockNumber:
                  type: string
                blockNumberGroups:
                  type: string
                dailyObdLimitPerNumber:
                  type: string
                record:
                  type: string
                dndEnable:
                  type: boolean
                offLineMode:
                  type: boolean
                stdEnabled:
                  type: boolean
                acwForUnAnsweredCall:
                  type: boolean
                dialByHoldingAgent:
                  type: boolean
                allowedManual:
                  type: boolean
                agentToAgentCalling:
                  type: boolean
                applyDNCRegulation:
                  type: boolean
                skills:
                  type: string
                script:
                  type: string
                amdDetection:
                  type: boolean
                customerFirst:
                  type: boolean
                recentFirst:
                  type: boolean
                amdDetected:
                  type: string
                voiceMessageURL:
                  type: string
                useTransferSkills:
                  type: boolean
                transferSkills:
                  type: string
                appToApp:
                  type: string
                holidays:
                  type: string
                workHoursSchedule:
                  type: array
                  items:
                    type: object
                    properties:
                      days:
                        type: array
                        items:
                          type: string
                      timeSlots:
                        type: array
                        items:
                          type: object
                          properties:
                            fromTime:
                              type: string
                            toTime:
                              type: string
      responses:
        '200':
          description: Campaign created successfully
          content:
            application/json:
              example:
                status: success
                message: Campaign created successfully
      operationId: postAPIServicesCampaignControlOutbound
      x-operation-id-source: derived
    servers:
    - url: https://{domainname}/
      description: The production API server
      variables:
        domainname:
          default: in1-ccaas-api.ozonetel.com
x-refined-from:
- ozonetel-add-campaign-data-basic-authentication-api-openapi.yml
- ozonetel-add-campaign-data-bulk-v4-api-openapi.yml
- ozonetel-campaign-phone-number-lookup-basic-auth-api-openapi.yml
- ozonetel-create-outbound-campaign-api-openapi.yml
x-provenance:
  method: searched
  source: https://docs.ozonetel.com/reference
  harvested: '2026-10-28'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.ozonetel.com/reference/post_cloudagentrestapi-index-php-addcampaignbulkdatav4-addbulkdata-format-json.md
  merge:
    pages: 1
    deduped: 0
    conflicts_kept_first: 0