diff --git a/docs/commands/pag.md b/docs/commands/pag.md new file mode 100644 index 0000000..4e93ec7 --- /dev/null +++ b/docs/commands/pag.md @@ -0,0 +1,75 @@ +# Introduction +`PAG` is a command introduced with [MSNP5](../versions/msnp5.md). + +It is a Notification Server command, with a request payload. + +It sends a text message to a mobile device or pager. +For the version of this command that supports Web Watches, read [PGD](pgd.md). + +# Client/Request +``` +PAG TrID user-handle length +payload +``` + +Where `user-handle` is the target user for this page. + +Where `length` is the length of `payload`. + +Where `payload` is a XML-like payload that encodes the following characters: +* `&` turns into `&` +* `;` turns into `;` +* `<` turns into `<` +* `>` turns into `>` +* `^` turns into `^` + +# Server/Response +This command only supports negative-acknoledgement responses only. +There is no postive acknoledgement response. + +# Examples + +## Sending without a callback number +``` +C: PAG 1 anotheruser@hotmail.com 61 +This is an example message. +``` + +## Sending with a home callback number +*NOTE: The number used was `1 (555) 111-4444`.* +``` +C: PAG 2 anotheruser@hotmail.com 149 +HOME15551114444This is an example message with a home callback number. +``` +## Sending with a work callback number +*NOTE: The number used was `1 (555) 222-5555`.* +``` +C: PAG 3 anotheruser@hotmail.com 149 +WORK15552225555This is an example message with a work callback number. +``` + +## Sending with a mobile callback number +*NOTE: The number used was `1 (555) 333-6666`.* +``` +C: PAG 4 anotheruser@hotmail.com 153 +MOBILE15553336666This is an example message with a mobile callback number. +``` + +## Failed to send +*This error may be a generic server error.* +``` +C: PAG 5 anotheruser@hotmail.com 61 +This is an example message. +S: 800 5 +``` + +## Removed +*Since [MSNP9](../versions/msnp9.md).* +``` +C: PAG 6 anotheruser@hotmail.com 61 +This is an example message. +S: 715 6 +``` + +# Known changes +* [MSNP9](../versions/msnp9.md): Removed (error 715), use [PGD](pgd.md) instead. diff --git a/docs/commands/pgd.md b/docs/commands/pgd.md new file mode 100644 index 0000000..429bf2d --- /dev/null +++ b/docs/commands/pgd.md @@ -0,0 +1,107 @@ +# Introduction +`PGD` is a command introduced with [MSNP9](../versions/msnp9.md). + +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](pag.md). + +# 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 length of `payload`. + +Where `payload` is a XML-like payload that encodes the following characters: +* `&` turns into `&` +* `;` turns into `;` +* `<` turns into `<` +* `>` turns into `>` +* `^` turns into `^` + +# Server/Response +This command only supports negative-acknoledgement responses only. +There is no postive acknoledgement response. + +# Examples + +## Sending to a mobile device + +### Sending without a callback number +``` +C: PGD 1 anotheruser@hotmail.com 1 74 +This is an example message. +``` + +### Sending with a home callback number +*NOTE: The number used was `1 (555) 111-4444`.* +``` +C: PGD 2 anotheruser@hotmail.com 1 161 +HOME15551114444This is an example message with a home callback number. +``` +### Sending with a work callback number +*NOTE: The number used was `1 (555) 222-5555`.* +``` +C: PGD 3 anotheruser@hotmail.com 1 161 +WORK15552225555This is an example message with a work callback number. +``` + +### Sending with a mobile callback number +*NOTE: The number used was `1 (555) 333-6666`.* +``` +C: PGD 4 anotheruser@hotmail.com 1 165 +MOBILE15553336666This is an example message with a mobile callback number. +``` + +### Failed to send +*This error may be a generic server error.* +``` +C: PGD 5 anotheruser@hotmail.com 1 74 +This is an example message. +S: 800 5 +``` + +## To a Web Watch +*NOTE: Trying to do this with the buddy property `MOB` set to `Y` is impossible.* + +### Normal use +``` +C: PGD 6 anotheruser@hotmail.com 2 74 +This is an example message. +``` + +### Failed to send +*This error may be a generic server error.* +``` +C: PGD 7 anotheruser@hotmail.com 2 74 +This is an example message. +S: 800 7 +``` + +## To an invalid device type + +### Numeric types +``` +C: PGD 8 anotheruser@hotmail.com 0 74 +This is an example message. +S: 201 8 +``` + +### Other character types +``` +C: PGD 9 anotheruser@hotmail.com W 74 +This is an example message. +``` + +Server disconnects client. + +# Known changes +None. diff --git a/docs/table_of_commands.md b/docs/table_of_commands.md index 5eda25b..089caea 100644 --- a/docs/table_of_commands.md +++ b/docs/table_of_commands.md @@ -42,18 +42,22 @@ This is a list of all known MSNP commands and their originating version. | [`SND`](commands/snd.md) | N | Y | N | [MSNP2](versions/msnp2.md) | [MSNP3](versions/msnp3.md) (parameters 2 and 3), [MSNP4](versions/msnp4.md) (parameter 4), [MSNP5](versions/msnp5.md) (obsoleted by [SDC](commands/sdc.md)) | | [`SDC`](commands/sdc.md) | Y | Y | N | [MSNP5](versions/msnp5.md) | | | [`ADC`](commands/adc.md) | N | Y | N?| [MSNP10](versions/msnp10.md) | [MSNP10](versions/msnp10.md) (`ABCHMigrated: 1` Contact user handles and Group IDs are now both GUIDs.), [MSNP13](versions/msnp13.md) (Removed; automatic disconnect, use ADL and the [Address Book Service](services/abservice.md) instead) | +| [`PAG`](commands/pag.md) | Y | Y | N | [MSNP5](versions/msnp5.md) | [MSNP9] (Removed; error 715, use [PGD](commands/pgd.md) instead.) | +| [`PGD`](commands/pgd.md) | Y | Y | N | [MSNP9](versions/msnp9.md) | | # What's Missing Right Now + +## For next parity check * [MSNP2](versions/msnp2.md): USR * [MSNP2](versions/msnp2.md): SYN * [MSNP5](versions/msnp5.md): NOT -* [MSNP5](versions/msnp5.md): PAG * [MSNP6](versions/msnp6.md): CHL * [MSNP6](versions/msnp6.md): IPG * [MSNP6](versions/msnp6.md): QRY * [MSNP7](versions/msnp7.md): REG * [MSNP7](versions/msnp7.md): RMG -* [MSNP9](versions/msnp9.md): PGD + +## In general * [MSNP10](versions/msnp10.md): SBP * [MSNP11](versions/msnp11.md): GCF * [MSNP11](versions/msnp11.md): SBS diff --git a/docs/versions/msnp5.md b/docs/versions/msnp5.md index fb9ec3d..6843299 100644 --- a/docs/versions/msnp5.md +++ b/docs/versions/msnp5.md @@ -6,7 +6,7 @@ It was introduced officially in Client Version 3.0.0283. It introduces the notification service commands: * [BPR](../commands/bpr.md) * NOT -* PAG +* [PAG](../commands/pag.md) * [PRP](../commands/prp.md) * [SDC](../commands/sdc.md) diff --git a/docs/versions/msnp9.md b/docs/versions/msnp9.md index 5652896..57e088a 100644 --- a/docs/versions/msnp9.md +++ b/docs/versions/msnp9.md @@ -4,7 +4,7 @@ It was introduced officially in Client Version 6.0.0312. # Command information It introduces the notification service commands: -* PGD +* [PGD](../commands/pgd.md) *No switchboard or dispatch service commands were known to be introduced in this version* @@ -12,7 +12,7 @@ It introduces the error codes: * 282 The following commands were removed in this version: -* PAG (returns 715) +* [PAG](../commands/pag.md) (returns 715) # Known changes (from [MSNP8](msnp8.md)):