Home > telephony > webhooks > func.telecoms.num.ref.set
function telecoms.num.ref.set

See also:

Assign a reference string to a phone number. Any subsequent calls to this number will have this reference string associated with them. The reference string can be fetched with the call data using the telecoms.calldata.detail.get function. See also: telecoms.num.list.

Arguments:

argrequired?syntaxinfo
custIDNposintcustID of account that owns the number (default is the account you're logged in to)
numberYTelNumidentifies the number whose reference string you want to set
refYstringthe reference string (up to 45 characters)

Returned Values

There are no return values other than indication of success or error.

Example 1

Setting the ref string. Any calls made to this number subsequently will have this ref string as one of the fields in the CDRs.

JSON example request:

POST https://live.apicontrol.co.uk/1/json
{
    "auth" : {
        "username" : "YOURUSERNAME",
        "password" : "YOURPASSWORD",
    },
   "func" : "telecoms.zone.list",
   "args" : {
      "number" : "03454633394",
      "ref" : "Arden Retailers"
   }
}

JSON example response:

{
   "success" : 1,
   "results" : {}
}