Chat features

IDEMPOTENCY_KEY=$(uuidgen) # Store it with your record of the reaction: reuse it to retry.

curl -sS https://api.isnap.ai/v1/messages/msg_3Lc6Yp1Hd8Xk2mQ4vTn7Bw9Rz/reactions \
  -H "Authorization: Bearer $ISNAP_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -d '{"type": "love"}'

import { randomUUID } from 'node:crypto'
import { ISnapClient, UnprocessableEntityError } from '@isnap/sdk'

const client = new ISnapClient({ apiKey: process.env.ISNAP_API_KEY ?? '', maxRetries: 2 })

const idempotencyKey = randomUUID() // Store it with your record of the reaction: reuse it to retry.

try {
  const reaction = await client.messages.addReaction(
    'msg_3Lc6Yp1Hd8Xk2mQ4vTn7Bw9Rz',
    { type: 'love' },
    { idempotencyKey }
  )
  // Requested, not placed yet: reaction.added confirms it.
  console.log(reaction.id, reaction.type, reaction.status)
} catch (err) {
  if (err instanceof UnprocessableEntityError && err.code === 'parent_not_yet_acked') {
    console.error('Wait for message.sent on this message, then try again.')
  } else if (err instanceof UnprocessableEntityError) {
    // sms_reactions_not_supported, multi_attachment_reaction or reaction_recipient_unsupported.
    console.error(`This message cannot take a reaction: ${err.code}`)
  } else {
    throw err
  }
}

import os
import uuid

import requests

API = "https://api.isnap.ai"
HEADERS = {"Authorization": f"Bearer {os.environ['ISNAP_API_KEY']}"}

idempotency_key = str(uuid.uuid4())  # Store it with your record of the reaction: reuse it to retry.
response = requests.post(
    f"{API}/v1/messages/msg_3Lc6Yp1Hd8Xk2mQ4vTn7Bw9Rz/reactions",
    headers={**HEADERS, "Idempotency-Key": idempotency_key},
    json={"type": "love"},
    timeout=30,
)

if response.status_code == 422:
    code = response.json()["error"]["code"]
    if code == "parent_not_yet_acked":
        print("Wait for message.sent on this message, then try again.")
    else:
        # sms_reactions_not_supported, multi_attachment_reaction or reaction_recipient_unsupported.
        print("This message cannot take a reaction:", code)
else:
    response.raise_for_status()
    reaction = response.json()["data"]
    # Requested, not placed yet: reaction.added confirms it.
    print(reaction["id"], reaction["type"], reaction["status"])

curl -sS -X POST https://api.isnap.ai/v1/chats/chat_7Bw9Rz3Lc6Yp1Hd8Xk2mQ4vTn/typing \
  -H "Authorization: Bearer $ISNAP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -sS -X DELETE https://api.isnap.ai/v1/chats/chat_7Bw9Rz3Lc6Yp1Hd8Xk2mQ4vTn/typing \
  -H "Authorization: Bearer $ISNAP_API_KEY"

import { ISnapClient, UnprocessableEntityError } from '@isnap/sdk'

const client = new ISnapClient({ apiKey: process.env.ISNAP_API_KEY ?? '', maxRetries: 2 })

const chatId = 'chat_7Bw9Rz3Lc6Yp1Hd8Xk2mQ4vTn'

try {
  const typing = await client.chats.typingStart(chatId, {})
  console.log(`Shown until ${typing.expires_at}, if the device can show it`)
  // ... write the answer, then clear the indicator if the answer is not sent.
  await client.chats.typingStop(chatId)
} catch (err) {
  if (err instanceof UnprocessableEntityError) {
    // sms_typing_not_supported or unsupported_handle: this chat cannot show it.
    console.error(err.code)
  } else {
    throw err
  }
}

import os

import requests

API = "https://api.isnap.ai"
HEADERS = {"Authorization": f"Bearer {os.environ['ISNAP_API_KEY']}"}
chat_id = "chat_7Bw9Rz3Lc6Yp1Hd8Xk2mQ4vTn"

response = requests.post(f"{API}/v1/chats/{chat_id}/typing", headers=HEADERS, json={}, timeout=30)
if response.status_code == 422:
    # sms_typing_not_supported or unsupported_handle: this chat cannot show it.
    print(response.json()["error"]["code"])
else:
    response.raise_for_status()
    print("Shown until", response.json()["data"]["expires_at"], "if the device can show it")
    # ... write the answer, then clear the indicator if the answer is not sent.
    requests.delete(f"{API}/v1/chats/{chat_id}/typing", headers=HEADERS, timeout=30).raise_for_status()

curl -sS -X POST https://api.isnap.ai/v1/chats/chat_7Bw9Rz3Lc6Yp1Hd8Xk2mQ4vTn/read \
  -H "Authorization: Bearer $ISNAP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

import { ISnapClient } from '@isnap/sdk'

const client = new ISnapClient({ apiKey: process.env.ISNAP_API_KEY ?? '', maxRetries: 2 })

const result = await client.chats.markRead('chat_7Bw9Rz3Lc6Yp1Hd8Xk2mQ4vTn', {})
console.log(`${result.marked_count} messages marked read at ${result.read_at}`)

import os

import requests

API = "https://api.isnap.ai"
HEADERS = {"Authorization": f"Bearer {os.environ['ISNAP_API_KEY']}"}

response = requests.post(
    f"{API}/v1/chats/chat_7Bw9Rz3Lc6Yp1Hd8Xk2mQ4vTn/read", headers=HEADERS, json={}, timeout=30
)
response.raise_for_status()
result = response.json()["data"]
print(result["marked_count"], "messages marked read at", result["read_at"])

IDEMPOTENCY_KEY=$(uuidgen) # Store it with your record of the card.

# Send this request once. A repeat with the same key returns 409 idempotency_conflict once the
# first request created the card's message, and sends the card when no message was created.
curl -sS https://api.isnap.ai/v1/chats/chat_7Bw9Rz3Lc6Yp1Hd8Xk2mQ4vTn/share-contact-card \
  -H "Authorization: Bearer $ISNAP_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -d '{
    "first_name": "Front desk",
    "organization": "Example Dental",
    "phone_numbers": ["+14155550124"]
  }'

import { randomUUID } from 'node:crypto'
import { ISnapClient } from '@isnap/sdk'

const client = new ISnapClient({ apiKey: process.env.ISNAP_API_KEY ?? '', maxRetries: 2 })

const idempotencyKey = randomUUID() // Store it with your record of the card.

// maxRetries: 0, because an automatic retry returns 409 instead of the result once the first
// attempt created the card's message.
const card = await client.chats.shareContactCard(
  'chat_7Bw9Rz3Lc6Yp1Hd8Xk2mQ4vTn',
  { first_name: 'Front desk', organization: 'Example Dental', phone_numbers: ['+14155550124'] },
  { idempotencyKey, maxRetries: 0 }
)
// status always reads queued: read the message to know whether iSnap holds it.
const message = await client.messages.get(card.message_id)
console.log(card.message_id, message.status)

import os
import uuid

import requests

API = "https://api.isnap.ai"
HEADERS = {"Authorization": f"Bearer {os.environ['ISNAP_API_KEY']}"}

idempotency_key = str(uuid.uuid4())  # Store it with your record of the card.

# Send this request once. A repeat with the same key returns 409 idempotency_conflict once the
# first request created the card's message, and sends the card when no message was created.
response = requests.post(
    f"{API}/v1/chats/chat_7Bw9Rz3Lc6Yp1Hd8Xk2mQ4vTn/share-contact-card",
    headers={**HEADERS, "Idempotency-Key": idempotency_key},
    json={"first_name": "Front desk", "organization": "Example Dental", "phone_numbers": ["+14155550124"]},
    timeout=30,
)
response.raise_for_status()
card = response.json()["data"]

# status always reads queued: read the message to know whether iSnap holds it.
message = requests.get(f"{API}/v1/messages/{card['message_id']}", headers=HEADERS, timeout=30)
message.raise_for_status()
print(card["message_id"], message.json()["data"]["status"])