WAPI - příkaz poll-req

Získání poslední nezpracované notifikace z POLL fronty

Datum: 15.11.2010


Získávání notifikací z POLL fronty se provádí kombinací příkazů poll-req a poll-ack. Popis systému notifikací naleznete na stránce WAPI - notifikace. Vždy je třeba notifikaci nejprve stáhnout, následně označit za přijatou a tím zpřístupnit případnou další. Notifikace jsou vraceny vždy od nejstarší po nejnovější.

Parametry

Tento příkaz nepřijímá žádné parametry.

Návratové hodnoty

  • 1000 - notifikace získána
  • 1003 - ve frontě není žádná nepřečtená notifikace
  • 2150 - váš účet nemá nastaveno stahování notifikací z poll fronty

Návratová data

Pokud existuje nestažená notifikace, je vrácena v uzlu notify s následující vnitřní strukturou:

  • code - návratová hodnota příkazu
  • result - textový popis návratové hodnoty
  • timestamp - čas vytvoření notifikace
  • clTRID - klientské id dotazu
  • svTRID - vnitřní id dotazu
  • command - příkaz
  • id - id notifikace (pro použití v poll-ack)

Příklad 1: získání notifikace

XML dotaz:

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

 

XML odpověď:

<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>

 

Příklad 2: prázdná fronta notifikací

XML dotaz:

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

 

XML odpověď:

<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>

Diskuze k článku

K tomuto článku nebyl dosud vložen žádný diskuzní příspěvek, ale můžete tak učinit jako první.

Přihlášení zákazníka

Nemáte ještě zákaznický účet? Registrace

Copyright © WEDOS, 2017

Facebook RSS