ANT
  • Introduction
    • Authentication
    • Number
    • Errors
    • Rate Limits
  • ANT API
    • Balance
      • Retrieve balance
    • Sms
      • Marketing SMS
        • Send Marketing SMS
        • Send Bulk Marketing SMS
        • Scheduled Marketing SMS
        • Marketing SMS CallBack
      • 🔥OTP SMS
        • Send OTP SMS
        • OTP SMS CallBack
        • ⭐OTP Backfill Interface
      • Notification SMS
        • Send Notification SMS
        • Send Bulk Notification SMS
        • Scheduled Notification SMS
        • Notification SMS CallBack
    • Voip
      • IVR
        • IVR File Upload
        • IVR Task
        • IVR Callback
      • Call
        • Call the phone
        • Call record callback
    • Phone Number Validation
      • HLR Sever
      • Check Number Status
  • Webhooks
    • Test Webhooks
  • Demo
    • Java Demo
Powered by GitBook
On this page
  1. ANT API
  2. Voip
  3. IVR

IVR Task

URL

https://api.antgst.com/call/ivr/v1/task

RequestMethod

POST

Content-Type

application/json

RequestBody

param
type
required
description

String

yes

API secretKey

countryCode

String

yes

country code(Example Indonesia 0062,Indian 0091)

sphoneList

BoArray

yes

Send SMS after answering

civrId

Number

yes

Ivr file id

timing

String

no

scheduled time (format:yyyy-MM-dd HH:mm:ss)

Request Example

{
	"authSecret": "16339529404a4xxxx4c9595625d452e7b12bf",
	"countryCode": "0062",
	"phoneList": ["0062811xxx","0062813xxxxx"],
	"ivrId": 10
}

Response Example

{
	"msg": "SUCCESS",
	"code": 200,
	"result": [
		{
			"phone": "0062811xxx",
			"callId": "c7c95b38xxx9f44309ae9758c3",
			"result": "SUCCESS"
		},
		{
			"phone": "0062813xxxxx",
			"callId": "74a237612d5xxxxe053728639b1",
			"result": "SUCCESS"
		}
	]
}

Response Param

param
type
descirption

msg

String

response msg

code

Number

status code

result

Object

response data

result.phone

String

phone number

result.callId

String

Icall unique id

result.result

tring

response result

PreviousIVR File UploadNextIVR Callback

Last updated 11 days ago

authSecret