Wiki

Clone wiki

Numera.LibrisAPI / channel.poll

Home > API Reference Documentation > channel.poll

channel.poll

Once you have a subscription id for a valid stream, you can use this command to receive new information from the subscription. If you are not using the Javascript SDK, you need to implement your own HTTP long-polling mechanism to make this action performant in your platform. Once the action returns data, you continue to call the action until you are done with the subscription.

Input Parameters

PropertyRequiredDescription
idyesChannel Id (a.k.a. channel Id you subscribed to)
tokenyestoken you received when you subscribed

Output

Every type of channel will output different results.

Dashboard Subscription

{
  "ResultSet": {
    "CallerInfo": {
      "calltype": "Normal",
      "id": "53a33290108c9b7dfd91a86f",
      "epi_info": "{\"demo_mode\": true, \"first_name\": \"358859040012800\", \"last_name\": \"2014-06-19T18:57:20.472555\", \"display_address\": \"\", \"dob\": \"None\", \"gender\": null, \"display_name\": \"gravytrain.dealer 358859040012800 2014-06-19T18:57:20.472555\"}",
      "name": "Loading...",
      "number": "3609820583"
    },
    "RendezVous": {
      "http_port": 8081,
      "realm": "gravytrain.dealer",
      "ip": "184.169.218.211",
      "id": 3522586242,
      "state": 3,
      "private_ip": "10.0.128.252",
      "timestamp": "1412274974000",
      "imei": "358859040012800",
      "event_state": "Complete",
      "is_event_state_closed": true,
      "port": 33334
    }
  }
}
PropertyDescription
CallerInfoJSON structure with caller info field
RendezVousJSON structure with the information to answer this specific call.

Possible Status Codes

Status CodeReasonDescription
1000MISSING_CHANNEL_IDYou have to send in the ID of the channel that you subscribed to
1001EXPIRED_CHANNELChannel is expired
1002UNEXPECTED_CHANNEL_ERRORUnexpected channel error

Updated