> For the complete documentation index, see [llms.txt](https://docs.fortics.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fortics.com.br/chat-center-api-reference/reference/models.md).

# Models

## The ErrorResponse object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"},"status":{"type":"boolean"},"code":{"type":"string"}}}}}}
```

## The ValidationErrorResponse object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"ValidationErrorResponse":{"type":"object","properties":{"status":{"type":"boolean"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}}}
```

## The GenericSuccessResponse object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"GenericSuccessResponse":{"type":"object","additionalProperties":true}}}}
```

## The AuthLoginRequest object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"AuthLoginRequest":{"type":"object","required":["email","password"],"properties":{"email":{"type":"string","description":"E-mail do usuário."},"password":{"type":"string","description":"Senha do usuário."},"device_token":{"type":"string"},"accept_token_service":{"type":"boolean"},"is_contact_center":{"type":"boolean"}}}}}}
```

## The AuthMeResponse object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"AuthMeResponse":{"type":"object","properties":{"_id":{"type":"string"},"email":{"type":"string"},"name":{"type":"string"},"session_agent":{"type":"object","nullable":true},"keep_alive":{"type":"integer"}}}}}}
```

## The SessionInitRequest object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"SessionInitRequest":{"type":"object","required":["contact_id","platform","channel_id","attendance","agent_id","agent_name"],"properties":{"contact_id":{"type":"string"},"platform":{"type":"string"},"channel_id":{"type":"string"},"attendance":{"type":"string"},"agent_id":{"type":"string"},"agent_name":{"type":"string"}}}}}}
```

## The SendMessageRequest object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"SendMessageRequest":{"type":"object","required":["platform_id","channel_id","type"],"properties":{"contact_name":{"type":"string"},"platform_id":{"type":"string"},"channel_id":{"type":"string"},"agent_id":{"type":"string"},"type":{"type":"string","enum":["text","media"]},"message":{"type":"string"},"file":{"type":"string"},"legend":{"type":"string"},"close_session":{"type":"integer","enum":[0,1,2,3]},"agent":{"type":"string","format":"email"},"attendance_id":{"type":"string"},"is_hsm":{"type":"boolean"},"hsm_template_name":{"type":"string"},"hsm_placeholders":{"type":"array","items":{"type":"string"}},"contact_variables":{"type":"object","additionalProperties":true},"gateway":{"type":"string"},"start_conversation":{"type":"boolean"},"subject":{"type":"string"},"session_data":{"type":"object","additionalProperties":true},"user_data":{"type":"object","additionalProperties":true},"contact_data":{"type":"object","additionalProperties":true},"context_id":{"type":"string"},"attachments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"preview":{"type":"string"}}}}}}}}}
```

## The MessageReadRequest object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"MessageReadRequest":{"type":"object","required":["platform_id","channel_id"],"properties":{"platform_id":{"type":"string"},"channel_id":{"type":"string"}}}}}}
```

## The AnnotationMessageRequest object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"AnnotationMessageRequest":{"type":"object","required":["annotation"],"properties":{"annotation":{"type":"string","maxLength":255}}}}}}
```

## The UpdateAgentRequest object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"UpdateAgentRequest":{"type":"object","properties":{"name":{"type":"string"},"ramal":{"type":"integer"},"password":{"type":"string"},"new_password":{"type":"string"},"default_language":{"type":"string"}}}}}}
```

## The SetTagCategoryRequest object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"SetTagCategoryRequest":{"type":"object","required":["session_id","tag_id"],"properties":{"session_id":{"type":"string"},"tag_id":{"type":"string"}}}}}}
```

## The DeleteTagCategoryRequest object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"DeleteTagCategoryRequest":{"type":"object","required":["session_id","tag_id"],"properties":{"session_id":{"type":"string"},"tag_id":{"type":"string"}}}}}}
```

## The PauseStartRequest object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"PauseStartRequest":{"type":"object","required":["pause_id"],"properties":{"pause_id":{"type":"string"},"isPausePersonalized":{"type":"boolean"}}}}}}
```

## The TranslateMessageRequest object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"TranslateMessageRequest":{"type":"object","required":["language","message"],"properties":{"language":{"type":"string"},"message":{"type":"string"},"session_id":{"type":"string"},"message_id":{"type":"string"}}}}}}
```

## The DetectLanguageRequest object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"DetectLanguageRequest":{"type":"object","required":["message","contact_id"],"properties":{"message":{"type":"string"},"contact_id":{"type":"string"}}}}}}
```

## The ToggleAutoTranslateRequest object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"ToggleAutoTranslateRequest":{"type":"object","required":["session_id"],"properties":{"session_id":{"type":"string"}}}}}}
```

## The ClickToCallRequest object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"ClickToCallRequest":{"type":"object","required":["contact_id"],"properties":{"contact_id":{"type":"string"},"whatsapp":{"type":"boolean"}}}}}}
```

## The AttendanceInitSessionRequest object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"AttendanceInitSessionRequest":{"type":"object","properties":{"contact_id":{"type":"string"},"platform":{"type":"string"},"channel_id":{"type":"string"},"team_id":{"type":"string"},"agent_id":{"type":"string"},"hsm_id":{"type":"string"},"tagMessage":{"type":"string"},"tagType":{"type":"string"}}}}}}
```

## The TransferRequest object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"TransferRequest":{"type":"object","required":["session_id","type"],"properties":{"session_id":{"type":"string"},"type":{"type":"string","enum":["attendance","agent"]},"attendance_id":{"type":"string"},"agent_id":{"type":"string"},"transfer_wait":{"type":"boolean"}}}}}}
```

## The FilterCampaignsByIdRequest object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"FilterCampaignsByIdRequest":{"type":"object","required":["campaings"],"properties":{"campaings":{"type":"array","items":{"type":"string"}},"paginate":{"type":"boolean"},"limit":{"type":"integer","minimum":1},"page":{"type":"integer","minimum":1}}}}}}
```

## The PredefinedMessagesRequest object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"PredefinedMessagesRequest":{"type":"object","required":["message","description"],"properties":{"message":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"}}}},"description":{"type":"string"}}}}}}
```

## The FindPredefinedMessagesByCampaignsRequest object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"FindPredefinedMessagesByCampaignsRequest":{"type":"object","required":["campaigns"],"properties":{"campaigns":{"type":"array","minItems":1,"items":{"type":"string"}},"order_by":{"type":"string","enum":["description","_id"]}}}}}}
```

## The ListAllHsmTemplatesRequest object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"ListAllHsmTemplatesRequest":{"type":"object","properties":{"attendance_id":{"type":"string"},"channel_id":{"type":"string"}}}}}}
```

## The ContactsAPIRequest object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"ContactsAPIRequest":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"number":{"type":"integer"},"group":{"type":"array","items":{"type":"string"}},"groups":{"type":"array","items":{"type":"string"}},"Whatsapp":{"type":"string"},"Instagram":{"type":"string"},"Telegram":{"type":"string"},"Messenger":{"type":"string"},"InstagramDirect":{"type":"string"},"GoogleChat":{"type":"string"},"ChatWeb":{"type":"string"},"Email":{"type":"string"},"MercadoLivre":{"type":"string"},"WhatsappBusiness":{"type":"string"},"Signal":{"type":"string"},"SMS":{"type":"string"},"ddi":{"type":"integer"},"default_language":{"type":"string"},"final_number":{"type":"integer"},"opt_in":{"type":"string"},"optin_gupshup":{"type":"boolean"}}}}}}
```

## The ContactAnnotationRequest object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"ContactAnnotationRequest":{"type":"object","required":["_id","agent_id"],"properties":{"_id":{"type":"string"},"observation":{"type":"string","nullable":true},"agent_id":{"type":"string"}}}}}}
```

## The ApplicationAttendanceRequest object

```json
{"openapi":"3.0.3","info":{"title":"API v4 - Fortics SZ4","version":"4.0"},"components":{"schemas":{"ApplicationAttendanceRequest":{"type":"object","properties":{"initial_grade":{"type":"number"},"final_grade":{"type":"number"}}}}}}
```


---

# 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://docs.fortics.com.br/chat-center-api-reference/reference/models.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.