URI for instant messaging

Last Updated : Aug 29, 2026 |
Prolog information
Metadata
Keywords:
In theURI format for messaging, the primary parameter is the comma-delimited list of participant addresses to a message. If a participant address is not reachable by, the address is not added to the conversation. If themessaging provider does not support multi-party instant messaging, only the address of the first participant is added to the conversation.
The generalizedURI format for messaging is avaya://message?participantAddress1,participantAddress2,...&subject=Sample%20%Subject.

Avaya URI embedded in a web page for messaging

Prolog information
Metadata
Keywords:
Support Service
Telephone Service
<a href="avaya://message?support@example.com">support@avaya.com</a>

Invoking anURI for messaging

Prolog information
Metadata
Keywords:
  • To test your URI on a Microsoft Windows workstation, invoke the following command in a command window or from the start menu: start avaya://message?support@avaya.com.
  • To test your URI on an Apple Macintosh workstation, invoke the following command in a command shell: open avaya://message?support@avaya.com.

Optional parameters for messaging

Prolog information
Metadata
Keywords:
Parameter
Value
Description
Subject
UTF-8 string, with html escapes.
The conversation subject is created or opened if the subject conversation with matching participants is found.
MessageBody
UTF-8 string, with html escapes.
The message body is inserted into the message dialog window. The actual message is not sent until theuser invokes send.
This parameter is not supported on all platforms.

URI for messaging

Prolog information
Metadata
Keywords:
Third-party applications can use the followingURI formats to directon desktop platforms to create a new conversation or open an existing conversation:
Scenario
Example and result
URI with a single valid messaging address
avaya://message?abc@avaya.com
checks whether there is an existing conversation with the contact.
  • If an existing conversation is available,opens the existing conversation with the specified contact.
  • If an existing conversation is unavailable,creates a new conversation with the specified contact.
URI with two or more valid messaging addresses
avaya://message?abc@avaya.com,xyz@avaya.com
checks whether there is an existing conversation with the two contacts.
  • If an existing conversation is available,opens the existing conversation with the two specified contacts.
  • If an existing conversation is unavailable,creates a new multiparty conversation with the two specified contacts.
URI with two or more valid messaging addresses appended with subject
avaya://message?abc@avaya.com,xyz@avaya.com&subject=Test%20%Subject
checks whether there is an existing conversation with the two contacts for the specified subject.
  • If an existing conversation is available,opens the existing conversation with the two specified contacts with the matching subject.
  • If an existing conversation is unavailable,creates a new multiparty conversation with the two specified contacts for the specified subject.
URI with two or more valid messaging addresses appended with subject and message body
avaya://message?abc@avaya.com,xyz@avaya.com&subject=Test%20%Subject&MessageBody="Message Body Sample"
checks whether there is an existing conversation with the two contacts for the specified subject.
  • If an existing conversation is available,opens the existing conversation with the two specified contacts with the matching subject. The opened conversation must have the provided message body text.
  • If an existing conversation is unavailable,creates a new multiparty conversation with the two specified contacts for the specified subject and message body text.
URI with two or more valid messaging addresses appended with subject and message body and CallBack URL
avaya://message?abc@avaya.com,xyz@avaya.com&subject=Test%20%Subject&MessageBody="Message Body Sample"&callbackURL=http://www.google.com
checks whether there is an existing conversation with the two contacts for the specified subject.
  • If an existing conversation is available,opens the existing conversation with the two specified contacts with the matching subject. The opened conversation must have the provided message body text. The callback URL opens in the default browser after the message is sent.
  • If an existing conversation is unavailable,creates a new multiparty conversation with the two specified contacts for the specified subject and message body text. The callback URL opens in the default browser after the message is sent.