> For the complete documentation index, see [llms.txt](https://docs.omnileads.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.omnileads.net/english/omnileads-restful-api/agent-session-api-in-asterisk.md).

# Agent Session API in Asterisk

### Agent Session API in Asterisk

Endpoints to control the agent session in Asterisk for the use of Webphone

### Asterisk Agent Login

Sets the Agent (Users) session status in Asterisk to logged in. The credentials must belong to the Agent, and no extra parameters need to be sent.

**URL**: POST [https:/](https://documentacion-omnileads.readthedocs.io/)/\<omnileads\_addr>/api/v1/asterisk\_login/

### Agent Logout in Asterisk

Sets the Agent (Users) session status in Asterisk to finished. The credentials must belong to the Agent, and no extra parameters need to be sent.

**URL**: POST [https:/](https://documentacion-omnileads.readthedocs.io/)/\<omnileads\_addr>/api/v1/asterisk\_logout/

### Agent pause entry

Sets the Agent (Users) session state in Asterisk to Paused (Pauses). Credentials must belong to the Agent.

**URL**: POST [https:/](https://documentacion-omnileads.readthedocs.io/)/\<omnileads\_addr>/api/v1/asterisk\_pause/

| field name | type   | description                       |
| ---------- | ------ | --------------------------------- |
| pause\_id  | string | ID of the pause the Agent enters. |

### Agent pause exit

Sets the Agent (Users) session status in Asterisk to "Available" and indicates the end of a Pause (Pauses). Credentials must belong to the Agent.

**URL**: POST [https:/](https://documentacion-omnileads.readthedocs.io/)/\<omnileads\_addr>/api/v1/asterisk\_unpause/

| field name | type   | description                      |
| ---------- | ------ | -------------------------------- |
| pause\_id  | string | ID of the pause the Agent exits. |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.omnileads.net/english/omnileads-restful-api/agent-session-api-in-asterisk.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.