Skip to main content

Documentation Index

Fetch the complete documentation index at: https://koreai.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Back to API List

​
Get All Contact Details Of Voice Campaigns

Retrieves the current status and contact details of a voice campaign.
MethodPOST
Endpointhttps://{{host}}/agentassist/api/v1/public/{{IID}}/campaign/{{campaignId}}/status?view=contacts
Content-Typeapplication/json
Authorizationauth: {{JWT}} See How to generate the JWT Token.
API ScopeCampaign Management

​
Path Parameters

ParameterDescriptionType
hostEnvironment URL, for example, https://platform.kore.aistring, required
IIdThe Application ID.string, required
campaignIdUnique identifier of the campaign to trigger.string, required

​
Query Parameter

ParameterDescriptionType
viewValue must be contacts to retrieve contacts only.string, optional

​
Sample Request

curl --location 'https://{{host}}/agentassist/api/v1/public/{{IID}}/campaign/{{campaignId}}/status?view=contacts' \
--header 'auth: <token>' \
--header 'iid: st-0603182c-7ffb-53c3-b307-47ca14b9xxxx' \
--header 'accountId: 67777ce93e25326494e9xxxx' \
--header 'Content-Type: application/json' \
--data '{
"page": 1,
"limit" : 100
}'

​
Headers

HeaderDescriptionRequired/Optional
authJWT token for authentication.required
iidThe Application Id.required
accountIdThe Account Id.required

​
Body Parameters

ParameterDescriptionType
pagePage number for pagination. Must be an integer ≥ 1. Used to fetch a specific page of results. Validations: Must be a number, Must be an integer, Minimum value: 1number, optional
limitMaximum number of records per page. Must be an integer between 1 and 100. Validations: Must be a number, Must be an integer, Minimum value: 1, Maximum value: 100number, optional

​
Sample Response

{
    "status": "success",
    "data": {
        "results": [
            {
                "phoneNumber": "919876543210",
                "uniqueId": "",
                "dialerOutcome": "",
                "numberOfAttemptsSoFar": 2,
                "botSessionId": "685d3c819e81807087b6xxxx",
                "agentDispositionCodes": [],
                "botOutboundStatus": "userHangUp",
                "botOutboundStatusDetail": "Client side"
            },
            {
                "phoneNumber": "125xxxx0200",
                "uniqueId": "",
                "dialerOutcome": "completed",
                "numberOfAttemptsSoFar": 1,
                "botSessionId": "685d3c4a6b208b1e96a1xxxx",
                "agentDispositionCodes": [
                    "System Generated"
                ],
                "botOutboundStatus": "userHangUp",
                "botOutboundStatusDetail": "user_hangup"
            },
            {
                "phoneNumber": "911234567890",
                "uniqueId": "",
                "dialerOutcome": "completed",
                "numberOfAttemptsSoFar": 1,
                "botSessionId": "685d3c479e81807087b6xxxx",
                "agentDispositionCodes": [
                    "Requires Supervisor Attention"
                ],
                "botOutboundStatus": "agentHangUp",
                "botOutboundStatusDetail": "agent_hangup"
            }
        ],
        "page": 1,
        "limit": 100,
        "totalPages": 1,
        "totalResults": 4
    }
}

​
Response Body Parameters

ParameterDescriptionType
statusIndicates the success or failure of the request.string
dataObject containing paginated call attempt records.object
data.resultsArray of call attempt results.array
data.results[].phoneNumberPhone number that the system attempted to reach.string
data.results[].uniqueIdUnique identifier for the call attempt (if any).string
data.results[].dialerOutcomeFinal outcome from the dialer (for example, completed, blank if in progress).string
data.results[].numberOfAttemptsSoFarNumber of call attempts made so far for the given number.integer
data.results[].botSessionIdIdentifier for the bot session associated with the call.string
data.results[].agentDispositionCodesList of agent-provided or system-generated disposition codes.array
data.results[].botOutboundStatusFinal status of the outbound interaction (for example, userHangUp, agentHangUp).string
data.results[].botOutboundStatusDetailAdditional detail about the outbound status.string
data.pageCurrent page number of the response.integer
data.limitMaximum number of results per page.integer
data.totalPagesTotal number of pages available.integer
data.totalResultsTotal number of results across all pages.integer