> For the complete documentation index, see [llms.txt](https://doc1.antgst.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc1.antgst.com/ant-api/voice/seat.md).

# Seat

Provides comprehensive lifecycle management for agent seats within the voice communication system. This API enables you to register SIP accounts as agent seats, assign them to specific seat groups or the default group, and manage their operational status. Each seat is bound to a unique SIP account. Supports batch seat creation, automatic default group provisioning, and ensures data integrity by preventing duplicate account assignments across seat groups.

## Add Seat

> Add one or more seats. If \`seatGroupId\` is omitted, the seats are assigned to the company's default seat group (created automatically on first use). Each \`account\` must reference an existing SIP account and must not already be bound to another seat group.

```json
{"openapi":"3.0.3","info":{"title":"Seat and Seat Group API","version":"1.0.0"},"servers":[{"url":"https://api.antgst.com/voice/v1"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"[X-API-Key](https://web.antgst.com/client/account/workspaceApi) = API key + API secret."}},"schemas":{"AddSeatRequest":{"type":"object","properties":{"account":{"type":"array","items":{"type":"string"},"description":"List of SIP accounts (extension numbers) to register as seats. Each value must match an existing SIP account and must not be already assigned to a seat group.","minItems":1},"seatGroupId":{"type":"integer","format":"int64","description":"Target seat group ID. If omitted, the company's default seat group is used (created automatically if it does not exist)."},"remark":{"type":"string","description":"Optional remark for the seats.","maxLength":255}},"required":["account"]},"BasicResponse":{"type":"object","properties":{"code":{"type":"integer","description":"Interface status code."},"msg":{"type":"string","description":"Interface response message."}}}}},"paths":{"/seat/add":{"post":{"summary":"Add Seat","description":"Add one or more seats. If `seatGroupId` is omitted, the seats are assigned to the company's default seat group (created automatically on first use). Each `account` must reference an existing SIP account and must not already be bound to another seat group.","operationId":"addSeat","tags":["Seats"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddSeatRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicResponse"}}}}}}}}}
```

## Delete Seat

> Delete a seat by its SIP account. The seat is removed from its seat group and the corresponding agent is removed from the group's real-time presence set.

```json
{"openapi":"3.0.3","info":{"title":"Seat and Seat Group API","version":"1.0.0"},"servers":[{"url":"https://api.antgst.com/voice/v1"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"[X-API-Key](https://web.antgst.com/client/account/workspaceApi) = API key + API secret."}},"schemas":{"BasicResponse":{"type":"object","properties":{"code":{"type":"integer","description":"Interface status code."},"msg":{"type":"string","description":"Interface response message."}}}}},"paths":{"/seat/delete/{account}":{"delete":{"summary":"Delete Seat","description":"Delete a seat by its SIP account. The seat is removed from its seat group and the corresponding agent is removed from the group's real-time presence set.","operationId":"deleteSeat","tags":["Seats"],"parameters":[{"name":"account","in":"path","required":true,"schema":{"type":"string"},"description":"SIP account of the seat to delete."}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicResponse"}}}}}}}}}
```


---

# 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, and the optional `goal` query parameter:

```
GET https://doc1.antgst.com/ant-api/voice/seat.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.