WAPI – komenda poll-req

Pobieranie notyfikacji z kolejki POLL odbywa się przez kombinację komend poll-req i poll-ack. Informacje o systemie notyfikacji są dostępne na stronie WAPI – notyfikacje. Najpierw trzeba pobrać notyfikację, potem oznaczyć ją jako przyjętą, po czym nastąpi udostępnienie kolejnej. Notyfikacje są zwracane zawsze od najstarszej do najnowszej.

Parametry

Komenda nie akceptuje żadnych parametrów.

Zwracane wartości

  • 1000 – notyfikacja pobrana
  • 1003 – w kolejce nie ma żadnej nieprzeczytanej notyfikacji
  • 2150 – u Twojego konta nie ustawiono pobierania notyfikacji z kolejki poll

Zwracane dane

Jeśli istnieje niepobrana notyfikacja, zostaje zwrócona w węźle notify o następującej strukturze wewnętrznej:

  • code – wartość zwrotna komendy
  • result – opis tekstowy wartości zwrotnej
  • timestamp – czas utworzenia notyfikacji
  • clTRID – id zapytania klienta
  • svTRID – wewnętrzne id zapytania
  • command – komenda
  • id – id notyfikacji (do użycia w poll-ack)

Przykład 1: pobranie notyfikacji

zapytanie XML:

<request>
 <user>tester</user>
 <auth>202b62bb4646281f97d225db1249840c8452dd8f</auth>
 <command>poll-req</command>
 <clTRID>LtVxXV9wLSWw</clTRID>
</request>

odpowiedź XML:

<response>
 <code>1000</code>
 <result>OK</result>
 <timestamp>1286962195</timestamp>
 <clTRID>LtVxXV9wLSWw</clTRID>
 <svTRID>1286962195.3105.9108.1</svTRID>
 <command>poll-req</command>
 <data>
  <notify>
   <code>1000</code>
   <result>OK</result>
   <timestamp>1286957040</timestamp>
   <clTRID>RKUFhhe5q8qw</clTRID>
   <svTRID>1286957032.2043.21543</svTRID>
   <command>ping-async</command>
   <id>2691</id>
  </notify>
 </data>
</response>

Przykład 2: pusta kolejka notyfikacji

zapytanie XML:

<request>
 <user>tester</user>
 <auth>202b62bb4646281f97d225db1249840c8452dd8f</auth>
 <command>poll-req</command>
 <clTRID>qQn32fUNTsfN</clTRID>
</request>

odpowiedź XML:

<response>
 <code>1003</code>
 <result>Empty notifications queue</result>
 <timestamp>1286962852</timestamp>
 <clTRID>qQn32fUNTsfN</clTRID>
 <svTRID>1286962852.1843.9155.1</svTRID>
 <command>poll-req</command>
</response>

Byl pro Vás tento návod užitečný?