For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGet API key
DocumentationIntegrationsAPI Reference
DocumentationIntegrationsAPI Reference
  • API Reference
      • GETList Conversations
      • GETGet Conversation
      • PATCHUpdate Conversation
      • GETGet Conversation Messages
      • POSTSend Typing Indicator
      • POSTSet Chat Background
      • DELRemove Chat Background
LogoLogo
HomeGet API key
API Referenceconversations

Send Typing Indicator

POST
https://api.agentphone.ai/v1/conversations/:conversation_id/typing
POST
/v1/conversations/:conversation_id/typing
1const url = 'https://api.agentphone.ai/v1/conversations/conversation_id/typing';
2const options = {
3 method: 'POST',
4 headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5 body: '{}'
6};
7
8try {
9 const response = await fetch(url, options);
10 const data = await response.json();
11 console.log(data);
12} catch (error) {
13 console.error(error);
14}
1{
2 "conversationId": "a1b2c3d4e5f678901234567890abcdef",
3 "channel": "iMessage",
4 "status": "typing indicator sent"
5}

Show a typing indicator in the conversation (iMessage only).

Best-effort: providers may silently drop the indicator if the chat hasn’t had recent activity, the recipient isn’t on iMessage, or it’s a group chat. Indicators auto-expire after a few seconds — no “stop typing” call needed.

Was this page helpful?
Previous

Set Chat Background

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

conversation_idstringRequired

Response

Successful Response
conversationIdstring
channelstring
statusstring

Errors

422
Unprocessable Entity Error