/click2call/

GET

https://www.exm.co.il/api/v1/click2call/

Initialize an outgoing call.
Use this endpoint to intiate an outgoing call from the dialer without using its GUI.

Upon success:

The physical phone will get an incoming call from Extra Mobile's dialer for Virtual Number and IVR number (currently: +972778040015 or +972778050015) or the caller_id for others. The caller id for this call may vary according to the parameters passed to the endpoint but you'll get it back in the dialer key of the numbers array. This also referred to as "Leg1 of the call".

When physical answers, a call will be made to destination. The caller id for this call will be the number passed in caller_id. This also referred to as "Leg2 of the call".

HOW IT WORKS?
When calling using the click2call method, we have two calls / "legs", joined into one once both parties answer.
Leg1:
physical gets a call. They see either +972778040015/+972778050015 on their screen if calling from a virtual/ivr number OR if otherwise, they'l see caller_id on their screen.

Leg2:
destination gets a call. They see caller_id on their screen.

IMPORTANT BILLING NOTICE:
API is billing-agnostic, meaning it will make the call regardless of your billing prefrences.
Calling from a virtual number may cost X (or free) while calling from other numbers can cost Y and billed by the minute / minutes plan, all according to terms for the client.
If you're not sure about costs, contact support.

LINKS:
Dialer: https://www.exm.co.il/dialer/
Verified Ids: https://www.exm.co.il/my/verified-ids/

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://www.exm.co.il/api/v1/click2call/?caller_id=+972778038038&physical=+972551234567&destination=+97236178888'

Response Example

Success

{
    "success": true,
    "call_id": "z87LXSIIb",
    "numbers": {
        "caller_id": "+972778038038",
        "physical": "+972544444444",
        "destination": "+972533333333",
        "dialer": "+972778050015"
    }
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

caller_id

string

required

e164 formatted telephone number of the number you wish to show on the destination screen when calling. MUST be a verified number for this account for the call to go through.
If calling from a Virtual Number or IVR number, write it here.

Example:

+972778038038

physical

string

required

e164 formatted physical telephone number of the actual device you wish to make the call FROM. Must be a verified number for this account.

Example:

+972551234567

destination

string

required

e164 formatted Israeli telephone number to make the call TO.

Example:

+97236178888

Responses

🟢200Success

application/json

Body

success

boolean

required

true when call initialize was successful, otherwise false

call_id

string

optional

The call identification on our system.

Example:

hsOKAEw

numbers

array [object {4}]

optional

Only on success. Holds the 4 numbers used in the click2call operation.

caller_id

string

required

Echo back from querystring.

Example:

+972778038038

destination

string

required

Echo back from querystring.

Example:

+97238888888

physical

string

required

Echo back from querystring.

Example:

+972541234567

dialer

string

required

The only number not passed in querystring. This is the caller id that will show on the screen of physical when making leg1 call.

Example:

+97278040015

errors

array [object {3}]

optional

Only on failure.

string

required

Reference to the name of the parameter the error was found in.

Example:

caller_id

code

integer

required

Numeric code of the error.

Example:

1010

description

string

required

Friendly description of the error.

Example:

Caller id number +9727780380380 is not a valid phone number

Modified at 2024-11-18 06:26:28

/calls/get-recording-urls/

/calls/recording/