diff --git a/src/modules/tm/doc/event_routes.xml b/src/modules/tm/doc/event_routes.xml index 5742edee492..f52f04fe9ce 100644 --- a/src/modules/tm/doc/event_routes.xml +++ b/src/modules/tm/doc/event_routes.xml @@ -1,5 +1,5 @@ -
@@ -13,18 +13,21 @@ event_route[tm:branch-failure] - Named branch failure routes can be defined to run when when a failure response is received. - This allows handling failures on individual branches, for example, retrying an alternative outbound flow. + Named branch failure routes can be defined to run when when a failure + response is received. This allows handling failures on individual + branches, for example, retrying an alternative outbound flow. - The format of the event_route name is "tm:branch-failure:<name>" and is enabled with the t_on_branch_failure function. + The format of the event_route name is "tm:branch-failure:<name>" + and is enabled with the t_on_branch_failure function. This event_route uses the BRANCH_FAILURE_ROUTE route type. <function>event_route[tm:branch-failure]</function> usage ... -route { +request_route { + ... t_on_branch_failure("myroute"); t_relay(); } diff --git a/src/modules/tm/doc/rpc.xml b/src/modules/tm/doc/rpc.xml new file mode 100644 index 00000000000..a846e1a67e3 --- /dev/null +++ b/src/modules/tm/doc/rpc.xml @@ -0,0 +1,166 @@ + + + +
+ + + RPC Commands + +
+ + <function moreinfo="none">tm.t_uac_start</function> + + + Generates and sends a local SIP request. + + Parameters: + + + method - request method + + + RURI - request SIP URI + + + NEXT HOP - next hop SIP URI (OBP); + use . if no value. + + + socket - local socket to be used for + sending the request; use . if no value. + + + headers - set of additional headers to + be added to the request; at least + From and To headers must be + provided) + + + body - (optional, may not be present) + request body (if present, requires the + Content-Type and Content-length + headers) + + +
+ +
+ + <function moreinfo="none">tm.t_uac_wait</function> + + + Similar to rm.t_uac_start, but waits for the SIP reponse and tries to + provide its details via RPC response. + +
+ +
+ + <function moreinfo="none">tm.cancel</function> + + + Generates and sends a CANCEL for an existing local SIP request. + + Parameters: + + + callid - callid of the INVITE request + to be cancelled. + + + cseq - cseq of the INVITE request to be + cancelled. + + +
+ +
+ + <function moreinfo="none">tm.hash_stats</function> + + + Gets information about the load of TM internal hash table. + + Parameters: + + + none + + +
+ +
+ + <function moreinfo="none">tm.reply</function> + + + Generates and sends a reply for an existing inbound SIP transaction. + + Parameters: + + + code - reply code + + + reason - reason phrase. + + + trans_id - transaction identifier + (has the hash_entry:label format) + + + to_tag - To tag to be added to TO header + + + new_headers - extra headers to be + appended to the reply; use a dot (.) char + only if there are no headers; + + + body - (optional, may not be present) + reply body (if present, requires the + Content-Type and Content-length + headers) + + +
+
+ + <function moreinfo="none">tm.reply_callid</function> + + + Generates and sends a reply for an existing inbound SIP transaction. + + Parameters: + + + code - reply code + + + reason - reason phrase. + + + callid - SIP Call-ID header + + + cseq - SIP CSeq header + + + to_tag - To tag to be added to TO header + + + new_headers - extra headers to be + appended to the reply; use a dot (.) char + only if there are no headers; + + + body - (optional, may not be present) + reply body (if present, requires the + Content-Type and Content-length + headers) + + +
+ +
diff --git a/src/modules/tm/doc/tm.xml b/src/modules/tm/doc/tm.xml index 823d942bba8..94eb2e49a3a 100644 --- a/src/modules/tm/doc/tm.xml +++ b/src/modules/tm/doc/tm.xml @@ -324,8 +324,9 @@ failure_route["serial"] - + +
Known Issues