OperatorAPI click2callinmovilla:list

newadmapi (Operator API) function. Available to: Operator.

Description

Lists the Inmovilla click-to-call agency links. OPERATOR-ONLY: the section exists in whitelabel/adm and NOT in the super-root tree - the first section in the port where the operator application has a screen the platform one does not. Tenant-scoped by the engine default. INSERT is off: cli and exten are NOT NULL with no default and the legacy form declares neither, so the legacy add has never worked. Paginated. Sorting and searching are restricted to the declared fields; anything else is rejected and named. Read audience is provisional pending operator confirmation.

Call

GET|POST https://YOUR_HOST:9089/newadm?func=click2callinmovilla:list

Send your API key with every request (header X-API-Key: YOUR_KEY, or Authorization: Bearer YOUR_KEY, or the ukey query parameter).

Parameters

None beyond the API key and func=click2callinmovilla:list.

Example

https://host:port/newadm?func=click2callinmovilla:list

Response

Success is {"ok":true,"data":{...}}; on refusal {"ok":false,"code":"...","message":"..."}. This function's data shape (n = number, s = string, ? = present only when set):

{
  "ok":true,
  "data":{
    "rows":[
      {
        "id":n,
        "accountcode":s,
        "context":s,
        "enabled":n
      }
    ],
    "page":n,
    "pagesize":n,
    "fields":[
      s
    ],
    "available":[
      s
    ],
    "order":s,
    "dir":s,
    "filterby":s?,
    "filter":s?
  }
}

Errors

Refusals carry a machine-readable code (branch on the code, never the message). See OperatorAPI#Error codes.

Back to OperatorAPI