API Documentation

Base URL : http://82.25.104.41:5000/

1. Create Call

Endpoint: POST /create-call

Description: Initiates a call between two numbers.

Request Body:

{
    "api_key": "string",
    "callbackURL": "string",
    "to_": "string",
    "from_": "string",
    "amd": "on/off"
}

Response:

{
    "message": "Call Created Successfully",
    "uuid": "string"
}

2. Play Audio

Endpoint: POST /play-audio

Description: Plays an audio file during an active call.

Request Body:

{
    "uuid": "string",
    "audiourl": "string"
}

Response:

{
    "message": "Audio-Play initiated",
    "uuid": "string"
}

3. Gather Audio

Endpoint: POST /gather-audio

Description: Gathers user input via DTMF tones.

Request Body:

{
    "uuid": "string",
    "audiourl": "string",
    "maxdigits": "string"
}

Response:

{
    "message": "Gather-Play initiated",
    "uuid": "string"
}

4. Gather Alpha

Endpoint: POST /gather-alpha

Description: Records audio input during a call.

Request Body:

{
    "uuid": "string"
}

Response:

{
    "message": "Gather-Alpha initiated",
    "uuid": "string"
}

5. Hangup Call

Endpoint: POST /hangup

Description: Terminates an active call.

Request Body:

{
    "uuid": "string"
}

Response:

{
    "message": "Call Ended",
    "uuid": "string"
}

6. Hold Call

Endpoint: POST /hold

Description: Puts an active call on hold.

Request Body:

{
    "uuid": "string"
}

Response:

{
    "message": "Call Held",
    "uuid": "string"
}

7. Unhold Call

Endpoint: POST /unhold

Description: Removes a call from hold.

Request Body:

{
    "uuid": "string"
}

Response:

{
    "message": "Call Unheld",
    "uuid": "string"
}

8. Check Balance

Endpoint: POST /balance

Description: Retrieves the account balance.

Request Body:

{
    "apikey": "string"
}

Response:

{
    "balance": "float",
    "message": "success"
}

Call-Related Responses

AMD (Answering Machine Detection) Responses

Playback-Related Responses

Recording-Related Responses

DTMF (Dual-Tone Multi-Frequency) Responses