Respond

The Respond function generates a SIP response to the current request message with the supplied status code and reason phrase.

Syntax

  Copy imageCopy Code 
bool Respond(
  string statusCode,
  string reasonPhrase,
  string appendHeader1,
  string appendHeader2,
   ...,
  string appendHeaderN
);

Parameters

statusCode

A SIP status code for the response, represented as a string (for example, "408").

reasonPhrase

A text message that describes the response reason (for example, "Server Not Available").

appendHeader1

The first new header to append to the message when responding. This parameter is optional.

appendHeader2

The second new header to append to the message when responding. This parameter is optional.

...

 

appendHeaderN

The last new header to append to the message when responding. This parameter is optional.

Return Values

Returns false if the current message is not a request (see the description of the sipRequest built-in variable in MSPL Built-in Variables), or if a non-1xx response has already been sent. Otherwise, it returns true.

Remarks

New headers are appended to the response by passing them in complete form as additional parameters to this function. For example, to add a "Contact" header to a response, the following call is correct:

  Copy imageCopy Code 
Respond("200", "OK", "Contact=<someone@example.com>;param1=value1");

If the "=" (equals) is not present in the appended header or headers, a critical MSPL error is raised for each occurrence where it must be present.