Documentation

Base URL

https://talyapp.net/api

Authentication

Authorization: Bearer YOUR_API_TOKEN
Accept: application/json
Content-Type: application/json

Contacts

GET/api/contacts

Get contact list

curl -X GET "https://talyapp.net/api/contacts?page=1&per_page=25" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

POST/api/contacts

Add contact

curl -X POST "https://talyapp.net/api/contacts" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "first_name": "John",
  "last_name": "Doe",
  "email": "john@example.com",
  "phone": "+966500000001",
  "group": ["00000000-0000-4000-8000-000000000000"]
}'

PUT/api/contacts/{uuid}

Edit contact

curl -X PUT "https://talyapp.net/api/contacts/00000000-0000-4000-8000-000000000000" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.updated@example.com",
  "phone": "+966500000001"
}'

DELETE/api/contacts/{uuid}

Delete contact

Contact groups

GET/api/contact-groups

Get contact group list

curl -X GET "https://talyapp.net/api/contact-groups?page=1&per_page=25" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

POST/api/contact-groups

Add contact group

curl -X POST "https://talyapp.net/api/contact-groups" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "VIP leads"
}'

PUT/api/contact-groups/{uuid}

Edit contact group

curl -X PUT "https://talyapp.net/api/contact-groups/00000000-0000-4000-8000-000000000000" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Qualified buyers"
}'

DELETE/api/contact-groups/{uuid}

Delete contact group

curl -X DELETE "https://talyapp.net/api/contact-groups/00000000-0000-4000-8000-000000000000" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Automated replies

GET/api/canned-replies

Get automated replies list

curl -X GET "https://talyapp.net/api/canned-replies?page=1&per_page=25" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

POST/api/canned-replies

Add automated reply

curl -X POST "https://talyapp.net/api/canned-replies" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Business hours",
  "trigger": "hours",
  "match_criteria": "contains",
  "response_type": "text",
  "response": "Our team is available Sunday to Thursday from 9 AM to 6 PM."
}'

PUT/api/canned-replies/{uuid}

Edit automated reply

curl -X PUT "https://talyapp.net/api/canned-replies/00000000-0000-4000-8000-000000000000" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Business hours",
  "trigger": "working hours",
  "match_criteria": "contains",
  "response_type": "text",
  "response": "Our team is available during official working hours."
}'

DELETE/api/canned-replies/{uuid}

Delete automated reply

curl -X DELETE "https://talyapp.net/api/canned-replies/00000000-0000-4000-8000-000000000000" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Messages

POST/api/send

Send message

curl -X POST "https://talyapp.net/api/send" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "phone": "+966500000001",
  "message": "Hello John, how can we help you today?",
  "header": "Customer support",
  "footer": "Reply with one of the options below",
  "buttons": [
    { "id": "sales", "title": "Sales" },
    { "id": "support", "title": "Support" }
  ]
}'

POST/api/send/media

Send media

curl -X POST "https://talyapp.net/api/send/media" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "phone": "+966500000001",
  "media_type": "image",
  "media_url": "https://example.com/property.jpg",
  "caption": "Attached property image",
  "file_name": "property.jpg"
}'

POST/api/send/template

Send template message

curl -X POST "https://talyapp.net/api/send/template" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "phone": "+966500000001",
  "template": {
    "name": "appointment_reminder",
    "language": { "code": "ar" },
    "components": [
      {
        "type": "body",
        "parameters": [
          { "type": "text", "text": "Ahmed" },
          { "type": "text", "text": "Thursday 4 PM" }
        ]
      }
    ]
  }
}'

Campaigns

POST/api/campaigns

Create campaign

curl -X POST "https://talyapp.net/api/campaigns" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "April property follow-up",
  "template": "00000000-0000-4000-8000-000000000000",
  "contacts": "all",
  "skip_schedule": true,
  "body": {
    "parameters": [
      { "type": "text", "text": "Ahmed" }
    ]
  }
}'

Commerce

GET/api/commerce/products

List products

curl -X GET "https://talyapp.net/api/commerce/products?page=1&per_page=20" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

POST/api/commerce/products

Create product

curl -X POST "https://talyapp.net/api/commerce/products" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Signature consultation",
  "sku": "CONSULT-001",
  "product_type": "service",
  "status": "active",
  "price": 250,
  "currency": "EGP",
  "category_name": "Consultations",
  "image_url": "https://example.com/catalog/consultation.jpg"
}'

PUT/api/commerce/products/{uuid}

Update product

curl -X PUT "https://talyapp.net/api/commerce/products/00000000-0000-4000-8000-000000000000" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Signature consultation",
  "status": "active",
  "price": 275
}'

GET/api/commerce/orders

List orders

curl -X GET "https://talyapp.net/api/commerce/orders?page=1&per_page=20&status=pending_payment" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

GET/api/commerce/orders/{uuid}

Show order

curl -X GET "https://talyapp.net/api/commerce/orders/00000000-0000-4000-8000-000000000000" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

PATCH/api/commerce/orders/{uuid}/status

Update order status

curl -X PATCH "https://talyapp.net/api/commerce/orders/00000000-0000-4000-8000-000000000000/status" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "confirmed",
  "note": "Confirmed by operations team."
}'

GET/api/commerce/appointments

List appointments

curl -X GET "https://talyapp.net/api/commerce/appointments?page=1&per_page=20&status=pending" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

GET/api/commerce/appointments/{uuid}

Show appointment

curl -X GET "https://talyapp.net/api/commerce/appointments/00000000-0000-4000-8000-000000000000" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

PATCH/api/commerce/appointments/{uuid}

Update appointment

curl -X PATCH "https://talyapp.net/api/commerce/appointments/00000000-0000-4000-8000-000000000000" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "confirmed",
  "notes": "Customer confirmed on WhatsApp."
}'

Templates

GET/api/templates

List templates

curl -X GET "https://talyapp.net/api/templates?page=1&per_page=25" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Verification

GET/api/verify

Verify API key

curl -X GET "https://talyapp.net/api/verify" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Error responses

Standard error

{
  "statusCode": 403,
  "code": "message_limit_reached",
  "message": "You have reached your message limit.",
  "request_id": "req_01hxexample"
}

Validation error

{
  "statusCode": 400,
  "code": "validation_error",
  "errors": {
    "phone": ["The phone number is not valid."]
  }
}

Developer API reference