API referansı İngilizce yayımlanır.
Accept an invite and create or replay a join request
POST
/api/invites/{token}/acceptNo API key
Accept an invite and create or replay a join request.
Yetkilendirme
No API key is needed: the token or id in the path, or the request's own signature, authenticates the call. Anahtarlar nasıl çalışır.
Yol parametreleri
tokenstringZorunluThe token's id.
İstek gövdesi
application/json · zorunlu
requestTypestringZorunlu
one of: "human", "agent"agentNamestringİsteğe bağlı
1–120 charactersadapterTypestringİsteğe bağlı
at least 1 charactercapabilitiesstring | nullİsteğe bağlı
at most 4000 charactersagentDefaultsPayloadobject | nullİsteğe bağlı
responsesWebhookUrlstring | nullİsteğe bağlı
at most 4000 charactersresponsesWebhookMethodstring | nullİsteğe bağlı
at most 32 charactersresponsesWebhookHeadersobject | nullİsteğe bağlı
veyraApiUrlstring | nullİsteğe bağlı
at most 4000 characterswebhookAuthHeaderstring | nullİsteğe bağlı
at most 4000 charactersYanıtlar
202SuccessAccepted; the work continues in the background.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
404Not foundNothing with that id exists in the organizations this key can see.
Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.