msnp-wiki/docs/commands/pgd.md
yellows111 ce7c3bee1c
0.2.0: The Winter Roll-up
i have basically touched every file help

* Moved all the error code stuff to one new sectional page, because the old way of doing it sucked big time.
* Rename passport (soap) to RST
* Formatting changes (many)
* Several corrections
* change git host because git.kevinthe.horse seems Dead
2024-12-18 20:16:29 +00:00

3 KiB

Introduction

PGD is a command introduced with MSNP9.

It is a Notification Server command, WITH a request payload.

It sends a text message to a mobile device/pager or Web Watch. For the version of this command that doesn't support Web watches, read PAG. For the command that is sent when you receive a page, read IPG.

Client/Request

PGD TrID user-handle device-type length
payload

Where user-handle is the target user for this page.

Where device-type is a number:

  • 1: Mobile Device
  • 2: Web Watch

Where length is the size (in bytes) of the payload.

Where payload is a XML-like payload that encodes the following characters:

  • & turns into &
  • ; turns into &#x3B;
  • < turns into &#x3C;
  • > turns into &#x3E;
  • ^ turns into &#x5E;

Server/Response

This command only supports negative-acknowledgement responses only. There is no postive acknowledgement response.

Examples

Sending to a mobile device

Sending without a callback number

C: PGD 1 anotheruser@hotmail.com 1 74
<TEXT xml:space="preserve" enc="utf-8">This is an example message.</TEXT>

Sending with a home callback number

NOTE: The number used was 1 (555) 111-4444.

C: PGD 2 anotheruser@hotmail.com 1 161
<PHONE pri="1"><LOC>HOME</LOC><NUM>15551114444</NUM></PHONE><TEXT xml:space="preserve" enc="utf-8">This is an example message with a home callback number.</TEXT>

Sending with a work callback number

NOTE: The number used was 1 (555) 222-5555.

C: PGD 3 anotheruser@hotmail.com 1 161
<PHONE pri="1"><LOC>WORK</LOC><NUM>15552225555</NUM></PHONE><TEXT xml:space="preserve" enc="utf-8">This is an example message with a work callback number.</TEXT>

Sending with a mobile callback number

NOTE: The number used was 1 (555) 333-6666.

C: PGD 4 anotheruser@hotmail.com 1 165
<PHONE pri="1"><LOC>MOBILE</LOC><NUM>15553336666</NUM></PHONE><TEXT xml:space="preserve" enc="utf-8">This is an example message with a mobile callback number.</TEXT>

Failed to send

This error may be a generic server error.

C: PGD 5 anotheruser@hotmail.com 1 74
<TEXT xml:space="preserve" enc="utf-8">This is an example message.</TEXT>
S: 800 5

To a Web Watch

NOTE: Trying to do this with the buddy property MOB set to Y is impossible in the official client.

Normal use

C: PGD 6 anotheruser@hotmail.com 2 74
<TEXT xml:space="preserve" enc="utf-8">This is an example message.</TEXT>

Failed to send

This error may be a generic server error.

C: PGD 7 anotheruser@hotmail.com 2 74
<TEXT xml:space="preserve" enc="utf-8">This is an example message.</TEXT>
S: 800 7

To an invalid device type

Numeric types

C: PGD 8 anotheruser@hotmail.com 0 74
<TEXT xml:space="preserve" enc="utf-8">This is an example message.</TEXT>
S: 201 8

Other character types

C: PGD 9 anotheruser@hotmail.com W 74
<TEXT xml:space="preserve" enc="utf-8">This is an example message.</TEXT>

Server disconnects client.

Known changes

None.