How to Make Phone Calls via HTTP API Using PushCall.

Introduction

This guide provides a step-by-step process on how to initiate phone calls using the PushCall API. To access the PushCall API, you'll need to obtain an API key by signing in at pushcall.me. U se this key in all API requests to authenticate your calls.

Make a phone call

To initiate a phone call, use the following HTTP request.

GET https://pushcall.me/api/call?api_key=xxxxxxxxxx&from=1&to=12345000000

Parameters:

• api_key - Your unique API key, available after signing in on pushcall.me.
• from - Caller ID index (choose between 1 and 5). This parameter selects the number from which the call will be made.
• to - The destination phone number (recipient).
  You can call multiple phone numbers by including this parameter multiple times.
  Excample: to=1000000000&to=2000000000&to=3000000000

Response Example:

{
  "success": true,
  "requestId": "fe3f7115fcac435f9e7a73b2c4e74312",
  "message": "The call has been performed",
  "from": "1740000000",
  "to": "12345000000"
}

Retrieving Call Information

To check the status of a completed call, use the following request:

GET https://pushcall.me/api/calls/fe3f7115fcac435f9e7a73b2c4e74312

This will return details about the call. Call status is typically available 30 seconds after the request.

Response Example:

{
  "id": "f99d551f4a394148b426d768fcb5fa64",
  "teamId": "1NN6SMQA",
  "plan": "BASIC",
  "availableCalls": 414,
  "from": "1740000000",
  "to": "30000000000",
  "status": "ANSWERED",
  "isMissed": false,
  "createdAt": "2024-09-17T13:17:19.000+00:00",
  "endedAt": "2024-09-17T13:17:38.000+00:00"
}

Key Fields:

• availableCalls - Number of available calls remaining for your current plan.

• from - The number (Caller ID) from which the call originated.

• to - The recipient’s phone number.

• status - The status of the call:

  • ANSWERED: The call was answered, either by the user or a voicemail system.
  • BUSY_HERE: The user declined the call (it means user got/sees this call).
  • TERMINATED: The call ended due to a timeout (30 seconds).
  • UNAVAILABLE: The recipient’s phone is unreachable.

• isMissed - A call is marked as missed if it ends without the recipient answering or declining within the call timeout. However, an answering machine's response is usually indistinguishable from a real answer and may also be counted as a call answered by the user.