1. References
  2. Management API
  3. CallerIDs
Rate this page:

CallerIDs

Methods

ActivateCallerID

Copy URL

Activates the CallerID by the verification code.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
ActivateCallerID example
Copy

ActivateCallerID example

Activate the callerID by the verification code.

Parameters

  • callerid_id:

    number

    ID of the callerID object

  • callerid_number:

    string

    The callerID number that can be used instead of callerid_id

  • verification_code:

    string

    The verification code, see the VerifyCallerID function

Returns

  • result:

    number

    1

AddCallerID

Copy URL

Adds a new caller ID. Caller ID is the phone that is displayed to the called user. This number can be used for call back.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
AddCallerID example
Copy

AddCallerID example

Parameters

  • callerid_number:

    string

    The callerID number in E.164 format

Returns

  • callerid_id:

    number

    ID of the callerID object

  • result:

    number

    1

DelCallerID

Copy URL

Deletes the CallerID. Note: you cannot delete a CID permanently (the antispam defence).

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
DelCallerID example
Copy

DelCallerID example

Delete the callerID 1.

Parameters

  • callerid_id:

    number

    ID of the callerID object

  • callerid_number:

    string

    The callerID number that can be used instead of callerid_id

Returns

  • result:

    number

    1

GetCallerIDs

Copy URL

Gets the account callerIDs.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
GetCallerIDs example
Copy

GetCallerIDs example

Get the two callerIDs.

Parameters

  • active:

    boolean

    Optional

    Whether the account is active to filter

  • callerid_id:

    number

    Optional

    ID of the callerID object to filter

  • callerid_number:

    string

    Optional

    The phone number to filter

  • count:

    number

    Optional
    Defaults on:  20

    The max returning record count

  • offset:

    number

    Optional
    Defaults on:  0

    The first N records are skipped in the output

  • order_by:

    string

    Optional

    The following values are available: 'caller_number' (ascent order), 'verified_until' (ascent order)

Returns

  • count:

    number

    The returned record count

  • result:

    [CallerIDInfoType]

  • total_count:

    number

    The total found record count

VerifyCallerID

Copy URL

Gets a verification code via phone call to the callerid_number.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
VerifyCallerID example
Copy

VerifyCallerID example

Verify the callerID 1.

Parameters

  • callerid_id:

    number

    ID of the callerID object

  • callerid_number:

    string

    The callerID number that can be used instead of callerid_id

Returns

  • result:

    number

    1