SIGN UP

Managing callerIDs

Methods

ActivateCallerID

Activates the CallerID by the verification code.

Parameters

  • Follow link for authentication parameter names and details.

  • callerid_id:

    number

    The 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

Examples

request:

Activate the callerID by the verification code.

https://api.voximplant.com/platform_api/ActivateCallerID/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&callerid_id=1&verification_code=12345

response:

Success

{
    "result": 1
}

AddCallerID

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

Parameters

  • Follow link for authentication parameter names and details.

  • callerid_number:

    string

    The callerID number in E.164 format.

Returns

  • result:

    number

    1

  • callerid_id:

    number

    The id of the callerID object.

  • verification_code_callin:

    string

    Code that can be endered to verify after dialing one of our call in numbers

Examples

request:

https://api.voximplant.com/platform_api/AddCallerID/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&callerid_number=74953331122

response:

{
    "result": 1,
    "callerid_id": 10
}

DelCallerID

Deletes the CallerID. Note: you can't delete a CID permanently (the antispam defence).

Parameters

  • Follow link for authentication parameter names and details.

  • callerid_id:

    number

    The id of the callerID object.

  • callerid_number:

    string

    The callerID number that can be used instead of callerid_id.

Returns

  • result:

    number

    1

Examples

request:

Delete the callerID 1.

https://api.voximplant.com/platform_api/DelCallerID/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&callerid_id=1

response:

Success

{
    "result": 1
}

GetCallerIDs

Gets the account callerIDs.

Parameters

  • Follow link for authentication parameter names and details.

  • callerid_id:

    number

    The id of the callerID object to filter.

  • callerid_number:

    string

    The phone number to filter.

  • active:

    boolean
    Optional

    The active flag to filter.

  • order_by:

    string
    Optional

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

  • count:

    number
    Optional
    Defaults to 20

    The max returning record count.

  • offset:

    number
    Optional
    Defaults to 0

    The first N records will be skipped in the output.

Returns

  • result:

    [ CallerIDInfoType ]
  • total_count:

    number

    The total found record count.

  • count:

    number

    The returned record count.

Examples

request:

Get the two callerIDs.

https://api.voximplant.com/platform_api/GetCallerIDs/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&count=2

Try to find the 79997770044 CID.

https://api.voximplant.com/platform_api/GetCallerIDs/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&callerid_number=79997770044

response:

{
    "count": 2,
    "result": [
        {
            "active": false,
            "callerid_id": 9,
            "callerid_number": "74959998877",
            "code_entering_attempts_left": 10,
            "verification_call_attempts_left": 5
        },
        {
            "active": true,
            "callerid_id": 11,
            "verified_until": "2014-01-14",
            "callerid_number": "74951112233"
        }
    ],
    "total_count": 4
}

VerifyCallerID

Gets a verification code by make call to the callerID number.

Parameters

  • Follow link for authentication parameter names and details.

  • callerid_id:

    number

    The id of the callerID object.

  • callerid_number:

    string

    The callerID number that can be used instead of callerid_id.

Returns

  • result:

    number

    1

Examples

request:

Verify the callerID 1.

https://api.voximplant.com/platform_api/VerifyCallerID/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&callerid_id=1

response:

Success

{
    "result": 1
}