Textový požadavek

Text Request je platforma pro obchodní texting sestavená k zarovnávání zapojení zákazníků. Vytvořili jsme řešení zasílání zpráv plug-and-play pro vaše každodenní komunikační problémy, takže můžete projít šumem a spojit se se zákazníky kdykoli a kdekoli. Přečtěte si další informace o tom, jak pomáháme zaneprázdněným obchodním manažerům, jako jste vy.

Tento konektor je dostupný v následujících produktech a oblastech:

Service	Class	Regions
Copilot Studio	Premium	Všechny oblasti Power Automate s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)
Logic Apps	Standard	Všechny oblasti Logic Apps s výjimkou následujících:      – Oblasti Azure Government      – Oblasti Azure China      - Ministerstvo obrany USA (DoD)
Power Apps	Premium	Všechny oblasti Power Apps s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)
Power Automate	Premium	Všechny oblasti Power Automate s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)

Kontakt
Název	Podpora rozhraní API pro žádosti o text
URL	https://www.textrequest.com/contact
Email	apidev@textrequest.com

Metadata konektoru
Vydavatel	Textový požadavek
Internetová stránka	https://www.textrequest.com/
Zásady ochrany osobních údajů	https://www.textrequest.com/privacy-policy/
Kategorie	Komunikace; Sales and CRM

Aranda Service Management Suite (ASMS)

Zvyšte produktivitu vaší společnosti a transformujte uživatelské prostředí díky Aranda Service Management Suite, víceklientské řešení, které umožňuje spravovat, integrovat a automatizovat obchodní procesy a služby. Vytváření, vyhledávání a aktualizace záznamů uložených v jakémkoli pracovním prostoru (projektu) SLUŽBY ASMS, včetně incidentů, požadavků a změn, mimo jiné.

Pre-requisites

Mějte na paměti následující předpoklady, abyste mohli pokračovat:

• Předplatné a instance sady Aranda Service Management Suite (ASMS). Začněte tady: https://arandasoft.com/
• Aktivní předplatné Microsoft Power Automate s možnostmi konektoru Premium.

Získání přihlašovacích údajů

• K ověření použijte integrační token. Na následujícím odkazu najdete informace o tom, jak získat integrační token.

Začínáme s konektorem

1. Vyžaduje předplatné sady Aranda Service Management Suite (ASMS).

2. Získání tokenu integrace

3. Získejte adresu URL instance rozhraní API ASMS (ApiAsms) pro správu služeb Aranda.

4. Vytvořte připojení ke konektoru Aranda Service Management Suite.

5. Vyberte jednu z následujících funkcí nabízených konektorem:

6. Podrobnou dokumentaci týkající se konektoru najdete v tématu https://docs.arandasoft.com/connectors

Tento konektor můžete použít v následujících případech:

1. Mezi další dostupné akce můžete vytvářet, vyhledávat a aktualizovat lístky.
2. Získejte sledovatelnost lístků.
3. Stáhněte si přílohy související s lístkem.
4. Vyhledejte články znalostní báze (KB) v Aranda Service Management Suite.
5. Stáhněte si přílohy z článků znalostní báze (KB).
6. Vytváření, vyhledávání a aktualizace položek konfigurace (CI).
7. Umožňuje organizacím vyřešit své interní žádosti o podporu, spravovat a streamovat proces řešení technických problémů.
8. Umožňuje sledování komunikace mezi žadateli a agenty podpory.
9. Nabídněte automatizovaným odpovědím, aby žadateli informovali o stavu svého lístku.

Úspěšná odpověď

Code	Název	Description
200	OK	Žádost byla úspěšná
204	Žádný obsah	V požadavku nebyla nalezena žádná data.

Běžné chyby a nápravné prostředky

Code	Název	Description	Solution
400	Špatný požadavek	KritériaNeedsSomeArguments	Zkontrolujte, že parametry hledání nejsou prázdné.
400	Špatný požadavek	InvalidAdditionalFieldId	Zkontrolujte správnost ID dalších polí.
400	Špatný požadavek	InvalidItemType	Typ případu je nesprávný, změňte ID typu případu.
400	Špatný požadavek	InvalidProjectId	ID projektu je nesprávné, změňte ID projektu, ke kterému přidružíte případ.
400	Špatný požadavek	InvalidStateId	Kontrola přidaného stavu při vytváření nebo aktualizaci lístku
400	Špatný požadavek	InvalidUploadType	Při připojování souboru došlo k chybě a požádejte o pomoc správce systému.
400	Špatný požadavek	RequestNeedsSomeArguments	Zkontrolujte požadovaná pole lístku a přidejte odpovídající hodnotu v konektoru.
400	Špatný požadavek	SearchListIsRequired	Žádost o pomoc od správce systému
400	Špatný požadavek	Název parametru: {Name parameter}	Zkontrolujte, jestli vlastnosti uvedené v chybě nemají hodnotu null.
400	Špatný požadavek	Je název parametru null: {Name parameter}	Zkontrolujte, jestli vlastnosti uvedené v chybě nemají hodnotu null.
400	Špatný požadavek	ItemTypeIsRequired	Přidat typ případu
400	Špatný požadavek	ModelIdIsEmpty	Přidejte parametr modelId. Je to povinné.
400	Špatný požadavek	StateIdIsEmpty	Přidejte parametr stateId. Je to povinné.
400	Špatný požadavek	ServiceIdIsEmpty	Přidejte parametr serviceId. Je to povinné.
400	Špatný požadavek	CategoryIdIsEmpty	Přidejte parametr categoryId. Je to povinné.
400	Špatný požadavek	TypesListNeedsSomeArguments	Vyžaduje přidání typu případu při hledání lístků, žádost o pomoc od správce systému.
400	Špatný požadavek	{PARAMETER_NAME} AdditionalFieldIsRequired	Další pole {PARAMETER_NAME} je povinné.
400	Špatný požadavek	ModelNotActive	Model přidružený k případu není aktivní.
400	Špatný požadavek	FailedToCloseTaskPendingCloseTasksPredecessors	Pokud se pokusíte případ zavřít a nadřazený případ obsahuje čekající úkoly k zavření
400	Špatný požadavek	DuplicatedObject	Ci již v databázi existuje.
400	Špatný požadavek	Název parametru EmptyValue: {PARAMETER_NAME}	Je vyžadován parametr {PARAMETER_NAME}.
400	Špatný požadavek	Název parametru EmptyEnumeration: {PARAMETER_NAME}	Parametr {PARAMETER_NAME} je seznam a vyžaduje se.
403	Zakázáno	DoNotHavePermissionForThisAction	Obraťte se na správce systému a přiřaďte oprávnění.

Code	Název	Description	Solution
500	Vnitřní chyba serveru		Žádost o pomoc od správce systému
500	Vnitřní chyba serveru	FailureExportExcel	Žádost o pomoc od správce systému
500	Vnitřní chyba serveru	FailureGetAdditionalFields	Žádost o pomoc od správce systému
500	Vnitřní chyba serveru	FailureGetCategoriesByService	Žádost o pomoc od správce systému
500	Vnitřní chyba serveru	FailureGetChangeFSC	Žádost o pomoc od správce systému
500	Vnitřní chyba serveru	FailureGetFields	Žádost o pomoc od správce systému
500	Vnitřní chyba serveru	FailureGetFieldsList	Žádost o pomoc od správce systému
500	Vnitřní chyba serveru	FailureGetFiles	Žádost o pomoc od správce systému
500	Vnitřní chyba serveru	FailureGetLookupValues	Žádost o pomoc od správce systému
500	Vnitřní chyba serveru	FailureGetMailTemplates	Žádost o pomoc od správce systému
500	Vnitřní chyba serveru	FailureGetModelByCategory	Žádost o pomoc od správce systému
500	Vnitřní chyba serveru	FailureGetOperators	Žádost o pomoc od správce systému
500	Vnitřní chyba serveru	Příčiny selháníGetReassignment	Žádost o pomoc od správce systému
500	Vnitřní chyba serveru	FailureGetSimilarItems	Žádost o pomoc od správce systému
500	Vnitřní chyba serveru	FailureSearchQuickManagement	Žádost o pomoc od správce systému

časté otázky

1. Jak načíst ID atributů potřebných k použití různých akcí v konektoru (např. projekt, služba, kategorie, skupina, specialista)?

   ID se dají načíst mnoha způsoby:

   • Pomocí Správce dotazů Aranda můžete vytvořit sestavu, která se dotazuje na tabulku Aranda Service Management Suite (ASMS), ve které se nacházejí požadovaná data. Pokud potřebujete pokyny k datovým objektům v řešení, navštivte následující odkaz https://docs.arandasoft.com/docs/database.html a identifikujte verzi databáze Aranda odpovídající vaší instalaci ASMS.
   • Pokud používáte místní instalaci ASMS, můžete dotazovat tabulku ASMS, ve které se požadovaná data nacházejí prostřednictvím klienta SQL.
   • Prostřednictvím centra podpory Aranda vytvořte žádost o podporu prostřednictvím kontaktních kanálů uvedených na následující webové podpoře.

2. Jaká je maximální velikost souborů, které se mají připojit při použití akce Přidat přílohu?

   Maximální velikost závisí na konkrétní konfiguraci vaší instance nebo instalace ASMS. Požádejte prosím správce ASMS.

3. Jaká je úroveň přístupu k datům vyžadovaná účtem technika, jehož token se používá v konfiguraci připojení ASMS vyžadovaného konektorem?

   Úroveň přístupu je stejná jako účet technika, který se pravidelně používá v ASMS. Jinými slovy, na základě rolí a oprávnění odpovídajících techniků v ASMS je možné získat přístup k datům pomocí konektoru.

4. Měl by mít účet technika, jehož token se použije v konektoru, pojmenovaný nebo souběžný?

   Vzhledem k tomu, že konektor má přístup k související instanci ASMS vícekrát za hodinu, důrazně doporučujeme, aby účet byl pojmenovaný typ.

5. Řídí se vytváření nebo úpravy případů pomocí konektoru stejnými pravidly ověření dat, která se nacházejí v rozhraní ASMS?

   Ano, řídí se stejnými ověřovacími pravidly. Například při vytváření případu pro konkrétní projekt, službu a kategorii, pokud musí být vyplněna nativní a další pole, jsou tato data vyžadována také při odesílání případu prostřednictvím konektoru.

6. Je možné konektor použít pro instance ASMS v cloudových a místních prostředích?

   Ano, dá se použít v cloudových i místních instalacích ASMS. V místních instalacích musíte zvážit připojení mezi serverem ASMS a prostředím Power Automate.

7. Mám licenci Power Automate, která mi umožňuje používat jenom standardní konektory. Můžu použít konektor ASMS?

   Není možné, konektor ASMS je typ Premium.

8. Chci vytvořit toky v Power Automate, které začínají od událostí v ASMS (například při vytvoření případu, kdy je případ přiřazen ke konkrétní skupině). Je možné použít triggery, které začínají událostmi, ke kterým dochází v ASMS?

   Ano, je to možné. Doporučuje se následující postup:

   • Inicializace triggeru Při přijetí požadavku HTTP a vytvoření schématu JSON textu požadavku obsahujícího datovou strukturu, kterou se očekává přijetí ze služby ASMS. Po vytvoření triggeru získáte adresu URL HTTP POST (WebHook URL), která se použije v instanci ASMS. Nezapomeňte zvážit mechanismus ověřování pro přístup k adrese URL webhooku (např. token).
   • Vytvořte obchodní pravidlo v ASMS pro sadu podmínek, které by při splnění měly inicializovat tok v Power Automate. Jako akci v rámci pravidla vyberte "Invoke Webhook" (Vyvolat webhook) a v cílové adrese URL vyvolání zadejte dříve získanou adresu URL webhooku, parametry pro odeslání a text požadavku (který se musí shodovat se schématem JSON textu požadavku). Další informace o vyvolání webhooku z pravidla v ASMS najdete na následujícím odkazu: Pravidlo Webhooku
   • Otestujte vytvořené pravidlo a ověřte odeslání požadavku HTTP na adresu URL webhooku a inicializuje tok v Power Automate.

9. Můžu v Power Automate vyvolat koncové body rozhraní REST API ASMS jako akce z toků?

   Ano, je to možné. Použijte akci "HTTP" a vyplňte v ní požadovaná data (identifikátor URI, metoda, hlavičky, tělo atd.).

Vytvoření připojení

Konektor podporuje následující typy ověřování:

výchozí	Parametry pro vytvoření připojení	Všechny oblasti	Nesdílitelné

Výchozí

Použitelné: Všechny oblasti

Parametry pro vytvoření připojení

Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.

Název	Typ	Description	Povinné
Klíč rozhraní API	securestring	Klíč rozhraní API pro toto rozhraní API	Pravdivé

Limity omezování

Name	Volání	Období obnovení
Volání rozhraní API na připojení	100	60 sekund

Akce

Aktualizace názvu konkrétního řídicího panelu	Aktualizuje řídicí panel. Tím se nezmění telefonní číslo řídicího panelu. Pokud chcete nové číslo s kontakty jiného řídicího panelu, budete muset vytvořit nový řídicí panel s post a přidat kontakty s hromadným exportem nebo importem.
Aktualizuje skupinu s daným ID.	Aktualizuje název skupiny pomocí číselného ID skupiny. Pokud předané ID skupiny neexistuje, volání selže.
Archivace konverzace	Archivuje konverzaci a odebere ji z výsledků všech koncových bodů načítání konverzací. Konverzace se automaticky zruší, pokud zákazník pošle text na číslo textové žádosti nebo pokud zákazníkovi pošlete text z čísla žádosti o text. Archivace konverzací je dobrý způsob, jak odebrat nepotřebné informace od zákazníků, se kterým v budoucnu neplánujete mluvit. Upozorňujeme, že pokud zákazník pošle text "STOP", aby vám zabránil v odesílání dalších SMS zpráv, konverzace se automaticky archivuje.
Hromadná aktualizace kontaktů	Pouze zadaný řídicí panel bude mít přidané kontakty; kontakty jsou uspořádané podle řídicího panelu a není k dispozici žádné vyhledávání na úrovni účtu.
Odeslání následného textu s připomenutím, že má uživatel zaplatit zadanou platbu	Odešle kontaktu připomenutí, aby zaplatil zadanou platbu. Obsah zprávy se automaticky vygeneruje. Aby se zabránilo spamu, může být na platbu odesláno pouze jedno připomenutí.
Odeslání zprávy kontaktu s daným telefonním číslem	Odešle zprávu (spuštění nové konverzace, pokud dané telefonní číslo nemá žádnou historii zpráv).
Odstraní kontakt se zadaným telefonním číslem.	Odstraní kontakt se zadaným telefonním číslem.
Odstraní skupinu se zadaným ID.	Odstraní skupinu se zadaným ID. To bude úspěšné i v případě, že jsou kontakty, které jsou členy skupiny (kontakty se neodstraní).
Odstraní zadaný řídicí panel.	Odstraní zadaný řídicí panel.
Označení platby jako zaplacené	Zavře platbu jako "placenou". Tento koncový bod použijte, pokud je platba zaplacena jiným způsobem než portálem žádosti o platbu. Tím platbu zavřete a přidáte její částku platby do statistiky. Tento koncový bod se nevyžaduje pro platby placené prostřednictvím portálu plateb odesílaných prostřednictvím textové žádosti; která automaticky označí platbu jako placenou.
Vytvoření nebo aktualizace kontaktu	Vytvoří nebo aktualizuje kontakt (v závislosti na tom, jestli už existuje s daným telefonním číslem).
Vytvoření nového řídicího panelu se zadaným jménem a telefonním číslem	Vytvoří nový řídicí panel v účtu. Po vytvoření řídicího panelu budou správci o změně e-mailem a můžou začít přiřazovat uživatele. Tento koncový bod může vytvořit řídicí panel pro všechna zřízená čísla. Zřízená čísla můžete vyhledat v určitém směrovém kódu oblasti pomocí funkce GET /dashboards/provisioning. Pokud je telefonní číslo již používáno, vyvolá se výjimka Chybný požadavek.
Vytvoří novou platbu.	Vytvoří novou platbu s poskytnutou zprávou poskytnutému kontaktu.
Vytvoří novou skupinu.	Vytvoří novou skupinu se zadaným názvem.
Zrušení archivace konverzace	Unarchives a conversation. Jakmile bude konverzace nearchivovaná, zobrazí se znovu ve frontě. zobrazí se také v konverzacích vrácených koncovým bodem /conversations. Pokud je konverzace již nearchivována, tato metoda nemá žádný vliv.
Zruší zadanou platbu.	Zruší zadanou platbu a odešle text uživatele, který platbu zrušil. Platby nelze upravit, takže zrušení a vystavení nové platby je nejlepší způsob, jak opravit platbu.
Získá kontakt se zadaným telefonním číslem.	Získá kontakt se zadaným telefonním číslem.
Získá platbu se zadaným ID.	Získá platbu se zadaným ID.
Získá všechna vlastní pole.	Získá všechna vlastní pole pro tento řídicí panel. Vlastní pole jsou mezi řídicími panely jedinečná.
Získá všechny konverzace pro tento řídicí panel.	Získá všechny konverzace pro tento řídicí panel a obsahuje informace o poslední zprávě pro každou konverzaci.
Získá všechny platby.	Získá všechny platby, včetně zrušených a placených plateb. Ty je možné filtrovat pomocí parametrů dotazu.
Získá všechny skupiny.	Získá všechny skupiny pro účet uživatele.
Získá všechny značky	Získá všechny značky pro tento řídicí panel. Značky jsou mezi řídicími panely jedinečné.
Získání informací o tomto konkrétním řídicím panelu	Vrátí název a telefon řídicího panelu.
Získání skupiny podle id	Získá skupinu se zadaným ID.
Získání všech kontaktů, které odpovídají zadanému kritériu filtrování	Získá všechny kontakty, které odpovídají zadanému kritériu filtrování. Prohledá se pouze zadaný řídicí panel; není k dispozici žádné vyhledávání na úrovni účtu.
Získání všech řídicích panelů v účtu	Získá všechny řídicí panely v účtu.
Získání zpráv konverzace podle telefonního čísla kontaktu	Získejte konverzaci mezi zadaným řídicím panelem a telefonním číslem.

Aktualizace názvu konkrétního řídicího panelu

ID operace:

UpdateDashboardsName

Aktualizuje řídicí panel. Tím se nezmění telefonní číslo řídicího panelu. Pokud chcete nové číslo s kontakty jiného řídicího panelu, budete muset vytvořit nový řídicí panel s post a přidat kontakty s hromadným exportem nebo importem.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.
Název řídicího panelu	name		string	Nový název řídicího panelu

Návraty

Name	Cesta	Typ	Description
identifikační číslo	id	integer	Číselné ID řídicího panelu.
název	name	string	Název řídicího panelu
telefon	phone	string	Textové číslo přidružené k tomuto řídicímu panelu.

Aktualizuje skupinu s daným ID.

ID operace:

UpdateGroup

Aktualizuje název skupiny pomocí číselného ID skupiny. Pokud předané ID skupiny neexistuje, volání selže.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.
ID skupiny	group_id	True	integer	Číselné ID skupiny, která se má aktualizovat.
Název skupiny	name		string	Nový název skupiny.
Poznámka ke skupině	notes		string	Krátká fráze popisující skupinu Používá se pro usnadnění.

Návraty

Name	Cesta	Typ	Description
identifikační číslo	id	integer	Číselné ID skupiny.
group_member_count	group_member_count	integer	Početčlenůch
is_keyword	is_keyword	boolean	Wheter tato skupina je skupina klíčových slov. Tyto skupiny se automaticky vygenerují, když uživatel nastaví klíčové slovo. Kontakty se při registraci automaticky přidají.
název	name	string	Název této skupiny.
poznámky	notes	string	Všechny poznámky k této skupině.
last_message_sent_utc	last_message_sent_utc	string	Časové razítko, kdy byla pro tuto skupinu odeslána poslední zpráva skupiny.

Archivace konverzace

ID operace:

ArchiveConversation

Archivuje konverzaci a odebere ji z výsledků všech koncových bodů načítání konverzací. Konverzace se automaticky zruší, pokud zákazník pošle text na číslo textové žádosti nebo pokud zákazníkovi pošlete text z čísla žádosti o text. Archivace konverzací je dobrý způsob, jak odebrat nepotřebné informace od zákazníků, se kterým v budoucnu neplánujete mluvit. Upozorňujeme, že pokud zákazník pošle text "STOP", aby vám zabránil v odesílání dalších SMS zpráv, konverzace se automaticky archivuje.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.
Telefonní číslo konverzace	phone_number	True	string	Telefonní číslo konverzace, která se má archivovat.

Návraty

response

string

Hromadná aktualizace kontaktů

ID operace:

BulkUpdateContacts

Pouze zadaný řídicí panel bude mít přidané kontakty; kontakty jsou uspořádané podle řídicího panelu a není k dispozici žádné vyhledávání na úrovni účtu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.
Telefonní číslo kontaktu	phone_number		string	Telefonní číslo kontaktu, který se má vytvořit nebo aktualizovat
Jméno kontaktu	first_name		string	Nové jméno kontaktu.
Příjmení kontaktu	last_name		string	Nové příjmení kontaktu.
Celé jméno kontaktu	display_name		string	Nové celé jméno kontaktu. Toto je výchozí název zobrazovaný ve webové aplikaci při prohlížení kontaktů.
Zda jsou zprávy z tohoto kontaktu potlačeny	is_suppressed		boolean	Určuje, jestli jsou konverzace s tímto kontaktem potlačeny, a proto se při přijetí nepřesouvají do horní části fronty zpráv.
Zda jsou zprávy z tohoto kontaktu archivovány	is_archived		boolean	Určuje, zda jsou konverzace s tímto kontaktem archivovány, a proto se při dotazování konverzací (ve výchozím nastavení) nedají zobrazit.
Jestli jsou zprávy z tohoto kontaktu blokované	is_blocked		boolean	Určuje, zda jsou konverzace s tímto kontaktem blokované, a proto nejsou přijaty nebo uloženy.
Důvod potlačení tohoto kontaktu	suppressed_reason		string	Fráze popisující důvod potlačení kontaktu
Kontaktní poznámka	note		string	Krátká fráze popisující kontakt Používá se pro usnadnění. Tento kontakt se nikdy nezobrazuje.
Skupiny kontaktů	groups		array of integer	Pole celočíselových ID odkazujících na skupiny, do nichž bude tento kontakt patřit.
Značky kontaktů	contact_tags		array of string	Pole guid odkazujících na značky připojené k tomuto kontaktu
ID vlastního pole	id		string	Guid odkazující na vlastní pole
Vlastní hodnota pole	value		string	Hodnota tohoto vlastního pole tohoto kontaktu.
Jestli se vyřešila aktuální konverzace s tímto kontaktem	is_resolved		boolean	Určuje, jestli je aktuální konverzace s tímto kontaktem vyřešena. Všechny nové texty přijaté tímto kontaktem nastaví tuto hodnotu false.

Návraty

Name	Cesta	Typ	Description
		array of object
telefonní číslo	phone_number	string	Telefonní číslo tohoto kontaktu.
first_name	first_name	string	Jméno tohoto kontaktu.
last_name	last_name	string	Příjmení tohoto kontaktu.
display_name	display_name	string	Celé jméno tohoto kontaktu. Toto je výchozí název zobrazovaný ve webové aplikaci při prohlížení kontaktů.
is_suppressed	is_suppressed	boolean	Jestli je konverzace s tímto kontaktem potlačena, a proto se při přijetí nepřesune do horní části fronty zpráv.
is_archived	is_archived	boolean	Zda je konverzace s tímto kontaktem archivována, a proto se při dotazování konverzací (ve výchozím nastavení) nedá zobrazit.
is_blocked	is_blocked	boolean	Bez ohledu na to, jestli je konverzace s tímto kontaktem blokovaná, a proto není přijatá nebo uložená.
suppressed_reason	suppressed_reason	string	Fráze popisující důvod potlačení kontaktu Pokud je is_suppressed false, bude mít hodnotu null.
poznámka	note	string	Krátká fráze popisující kontakt Používá se pro usnadnění. Tento kontakt se nikdy nezobrazuje.
groups	groups	array of integer	Pole celočíselových ID odkazujících na skupiny, do nichž tento kontakt patří.
contact_tags	contact_tags	array of string	Pole guid odkazujících na značky připojené k tomuto kontaktu
custom_fields	custom_fields	array of object	Pole id a hodnot vlastních polí definovaných pro tento kontakt
identifikační číslo	custom_fields.id	string	Guid odkazující na vlastní pole
value	custom_fields.value	string	Hodnota tohoto vlastního pole tohoto kontaktu.
is_resolved	is_resolved	boolean	Jestli je konverzace s tímto kontaktem vyřešená. Všechny nové texty přijaté tímto kontaktem nastaví tuto hodnotu false.
first_contact_utc	first_contact_utc	string	Časové razítko odeslání první zprávy tomuto kontaktu.
opted_out_utc	opted_out_utc	string	Časové razítko, kdy se tento kontakt odhlásil k příjmu zpráv.
last_msg_sent_utc	last_msg_sent_utc	string	Časové razítko poslední zprávy odeslané tomuto kontaktu.
last_msg_received_utc	last_msg_received_utc	string	Časové razítko, kdy byla od tohoto kontaktu přijata poslední zpráva.
total_msgs_sent	total_msgs_sent	integer	Celkový počet zpráv odeslaných tomuto kontaktu
total_msgs_received	total_msgs_received	integer	Celkový počet zpráv přijatých od tohoto kontaktu
response_count	response_count	integer	Celkový počet zpráv odpovědí od kontaktu
date_created_utc	date_created_utc	string	Časové razítko vytvoření kontaktu.
last_contact_date_utc	last_contact_date_utc	string	Časové razítko, kdy byla od tohoto kontaktu odeslána nebo přijata poslední zpráva.
message_id	last_message.message_id	string	ID zprávy. Tato hodnota je jedinečná pro každou zprávu.
body	last_message.body	string	Obsah této zprávy
message_direction	last_message.message_direction	string	Jednoznamový znak, R nebo S, označující, zda byla tato zpráva přijata od kontaktu nebo odeslána jim, v uvedeném pořadí.
response_by_username	last_message.response_by_username	string	Uživatelské jméno uživatele textové žádosti, který naposledy odeslal zprávu tomuto uživateli.
message_timestamp_utc	last_message.message_timestamp_utc	string	Časové razítko, kdy byla zpráva odeslána nebo přijata textovým požadavkem.
delivery_status	last_message.delivery_status	string	Aktuální stav této zprávy Může se jednat o odesílání, doručení, chybu nebo odeslání.
delivery_error	last_message.delivery_error	string	Chyba, která způsobila nedoručovat tuto zprávu. Pokud delivery_status není chyba, bude tato hodnota null.
mms_media	last_message.mms_media	array of string	Seznam adres URL odkazující na přílohy této zprávy Všechny adresy URL budou generované textovou adresou URL.

Odeslání následného textu s připomenutím, že má uživatel zaplatit zadanou platbu

ID operace:

SendPaymentReminder

Odešle kontaktu připomenutí, aby zaplatil zadanou platbu. Obsah zprávy se automaticky vygeneruje. Aby se zabránilo spamu, může být na platbu odesláno pouze jedno připomenutí.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.
ID platby	payment_id	True	integer	Číselné ID platby, která se má aktualizovat.

Návraty

Name	Cesta	Typ	Description
payment_id	payment_id	integer	Číselné ID platby.
request_date	request_date	string	Časové razítko, kdy byla počáteční zpráva této platby zařazena do fronty k odeslání.
příjemce	recipient	string	Jméno příjemce platby. Tato hodnota může mít hodnotu null, pokud kontakt nemá přidružené jméno ke svému telefonnímu číslu.
popis	description	string	Popis platby. Tento kontakt se nezobrazuje. Používá ho pouze interní uživatelé pro kontext plateb.
customer_phone	customer_phone	string	Telefonní číslo kontaktu, který tuto platbu posílá.
amount_requested	amount_requested	float	Částka v dolarech požadovaných touto platbou.
is_past_due	is_past_due	boolean	Určuje, jestli je tato platba za datem žádosti.
reminder_was_sent	reminder_was_sent	boolean	Jestli už byla pro tuto platbu odeslána textová připomenutí.
transaction_status	transaction_status	string	Stav transakce v authvia. Tato hodnota začíná jako Neznámá.
textrequest_payment_status	textrequest_payment_status	string	Stav transakce v textovém požadavku. To představuje stav zobrazený na stránce plateb v aplikaci Text Request. Spustí se jako Odeslaná.
reference_number	reference_number	string	ID definované uživatelem definované při vytváření plateb, které se dají použít k rychlému vyhledání plateb. Referenční čísla nejsou jedinečná; mnoho plateb může mít stejný odkaz.

Odeslání zprávy kontaktu s daným telefonním číslem

ID operace:

SendMessageByPhoneNumber

Odešle zprávu (spuštění nové konverzace, pokud dané telefonní číslo nemá žádnou historii zpráv).

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.
Telefonní číslo ke zprávě	phone_number	True	string	Telefonní číslo kontaktu, na který chcete poslat zprávu.
Text zprávy	body		string	Obsah zprávy, která se má odeslat
Jméno odesílatele	sender_name		string	Jméno odesílatele zprávy. To se zobrazí ve webové aplikaci TextRequest a rozhraní API při načítání této zprávy.
Adresa URL zpětného volání pro při aktualizaci stavu zprávy	status_callback		string	Adresa URL pro webovou aplikaci, která se má stisknout s příkazem POST, kdykoli stav této zprávy přejde z nedoručené na odeslanou (nebo chybovou zprávu).
Adresa URL zpětného volání pro žádosti o umístění, pokud tato zpráva obsahuje jednu	location_callback		string	Adresa URL zpětného volání umístění, která se zobrazí pomocí příkazu POST, když uživatel přistupuje a schválí sdílení polohy s odesílatelem. Pokud chcete odkaz zahrnout, přidejte do textu zprávy [Žádost o umístění]. Toto zpětné volání není vyžadováno pro žádosti o umístění, ale může být užitečné pro rozhraní API.
Přílohy médií MMS pro tuto zprávu	mms_media		array of string	Pole příloh médií MMS pro tuto zprávu Přílohy musí být adresy URL z koncového bodu post /mms (nejsou součástí tohoto konektoru). Odkazy externí přílohy nebudou přijaty.

Návraty

Name	Cesta	Typ	Description
message_id	message_id	string	ID zprávy. Tato hodnota je jedinečná pro každou zprávu.
body	body	string	Obsah této zprávy
message_direction	message_direction	string	Jednoznamový znak, R nebo S, označující, zda byla tato zpráva přijata od kontaktu nebo odeslána jim, v uvedeném pořadí.
response_by_username	response_by_username	string	Uživatelské jméno uživatele textové žádosti, který naposledy odeslal zprávu tomuto uživateli.
message_timestamp_utc	message_timestamp_utc	string	Časové razítko, kdy byla zpráva odeslána nebo přijata textovým požadavkem.
delivery_status	delivery_status	string	Aktuální stav této zprávy Může se jednat o odesílání, doručení, chybu nebo odeslání.
delivery_error	delivery_error	string	Chyba, která způsobila nedoručovat tuto zprávu. Pokud delivery_status není chyba, bude tato hodnota null.
mms_media	mms_media	array of string	Seznam adres URL odkazující na přílohy této zprávy Všechny adresy URL budou generované textovou adresou URL.

Odstraní kontakt se zadaným telefonním číslem.

ID operace:

DeleteContact

Odstraní kontakt se zadaným telefonním číslem.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.
Telefonní číslo kontaktu	phone_number	True	string	Telefonní číslo kontaktu, který chcete odstranit.

Návraty

response

string

Odstraní skupinu se zadaným ID.

ID operace:

DeleteGroup

Odstraní skupinu se zadaným ID. To bude úspěšné i v případě, že jsou kontakty, které jsou členy skupiny (kontakty se neodstraní).

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.
ID skupiny	group_id	True	integer	Číselné ID skupiny, která se má odstranit.

Návraty

response

string

Odstraní zadaný řídicí panel.

ID operace:

DeleteDashboard

Odstraní zadaný řídicí panel.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.

Návraty

response

string

Označení platby jako zaplacené

ID operace:

MarkPaymentPaid

Zavře platbu jako "placenou". Tento koncový bod použijte, pokud je platba zaplacena jiným způsobem než portálem žádosti o platbu. Tím platbu zavřete a přidáte její částku platby do statistiky. Tento koncový bod se nevyžaduje pro platby placené prostřednictvím portálu plateb odesílaných prostřednictvím textové žádosti; která automaticky označí platbu jako placenou.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.
ID platby	payment_id	True	integer	Číselné ID platby, která se má aktualizovat.

Návraty

Name	Cesta	Typ	Description
payment_id	payment_id	integer	Číselné ID platby.
request_date	request_date	string	Časové razítko, kdy byla počáteční zpráva této platby zařazena do fronty k odeslání.
příjemce	recipient	string	Jméno příjemce platby. Tato hodnota může mít hodnotu null, pokud kontakt nemá přidružené jméno ke svému telefonnímu číslu.
popis	description	string	Popis platby. Tento kontakt se nezobrazuje. Používá ho pouze interní uživatelé pro kontext plateb.
customer_phone	customer_phone	string	Telefonní číslo kontaktu, který tuto platbu posílá.
amount_requested	amount_requested	float	Částka v dolarech požadovaných touto platbou.
is_past_due	is_past_due	boolean	Určuje, jestli je tato platba za datem žádosti.
reminder_was_sent	reminder_was_sent	boolean	Jestli už byla pro tuto platbu odeslána textová připomenutí.
transaction_status	transaction_status	string	Stav transakce v authvia. Tato hodnota začíná jako Neznámá.
textrequest_payment_status	textrequest_payment_status	string	Stav transakce v textovém požadavku. To představuje stav zobrazený na stránce plateb v aplikaci Text Request. Spustí se jako Odeslaná.
reference_number	reference_number	string	ID definované uživatelem definované při vytváření plateb, které se dají použít k rychlému vyhledání plateb. Referenční čísla nejsou jedinečná; mnoho plateb může mít stejný odkaz.

Vytvoření nebo aktualizace kontaktu

ID operace:

CreateContact

Vytvoří nebo aktualizuje kontakt (v závislosti na tom, jestli už existuje s daným telefonním číslem).

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.
Telefonní číslo kontaktu	phone_number	True	string	Telefonní číslo kontaktu, který se má vytvořit nebo aktualizovat
Jméno kontaktu	first_name		string	Nové jméno kontaktu.
Příjmení kontaktu	last_name		string	Nové příjmení kontaktu.
Celé jméno kontaktu	display_name		string	Nové celé jméno kontaktu. Toto je výchozí název zobrazovaný ve webové aplikaci při prohlížení kontaktů.
Zda jsou zprávy z tohoto kontaktu potlačeny	is_suppressed		boolean	Určuje, jestli jsou konverzace s tímto kontaktem potlačeny, a proto se při přijetí nepřesouvají do horní části fronty zpráv.
Zda jsou zprávy z tohoto kontaktu archivovány	is_archived		boolean	Určuje, zda jsou konverzace s tímto kontaktem archivovány, a proto se při dotazování konverzací (ve výchozím nastavení) nedají zobrazit.
Jestli jsou zprávy z tohoto kontaktu blokované	is_blocked		boolean	Určuje, zda jsou konverzace s tímto kontaktem blokované, a proto nejsou přijaty nebo uloženy.
Důvod potlačení tohoto kontaktu	suppressed_reason		string	Fráze popisující důvod potlačení kontaktu
Kontaktní poznámka	note		string	Krátká fráze popisující kontakt Používá se pro usnadnění. Tento kontakt se nikdy nezobrazuje.
Skupiny kontaktů	groups		array of integer	Pole celočíselových ID odkazujících na skupiny, do nichž bude tento kontakt patřit.
Značky kontaktů	contact_tags		array of string	Pole guid odkazujících na značky připojené k tomuto kontaktu
ID vlastního pole	id		string	Guid odkazující na vlastní pole
Vlastní hodnota pole	value		string	Hodnota tohoto vlastního pole tohoto kontaktu.
Jestli se vyřešila aktuální konverzace s tímto kontaktem	is_resolved		boolean	Určuje, jestli je aktuální konverzace s tímto kontaktem vyřešena. Všechny nové texty přijaté tímto kontaktem nastaví tuto hodnotu false.

Návraty

Name	Cesta	Typ	Description
telefonní číslo	phone_number	string	Telefonní číslo tohoto kontaktu.
first_name	first_name	string	Jméno tohoto kontaktu.
last_name	last_name	string	Příjmení tohoto kontaktu.
display_name	display_name	string	Celé jméno tohoto kontaktu. Toto je výchozí název zobrazovaný ve webové aplikaci při prohlížení kontaktů.
is_suppressed	is_suppressed	boolean	Jestli je konverzace s tímto kontaktem potlačena, a proto se při přijetí nepřesune do horní části fronty zpráv.
is_archived	is_archived	boolean	Zda je konverzace s tímto kontaktem archivována, a proto se při dotazování konverzací (ve výchozím nastavení) nedá zobrazit.
is_blocked	is_blocked	boolean	Bez ohledu na to, jestli je konverzace s tímto kontaktem blokovaná, a proto není přijatá nebo uložená.
suppressed_reason	suppressed_reason	string	Fráze popisující důvod potlačení kontaktu Pokud je is_suppressed false, bude mít hodnotu null.
poznámka	note	string	Krátká fráze popisující kontakt Používá se pro usnadnění. Tento kontakt se nikdy nezobrazuje.
groups	groups	array of integer	Pole celočíselových ID odkazujících na skupiny, do nichž tento kontakt patří.
contact_tags	contact_tags	array of string	Pole guid odkazujících na značky připojené k tomuto kontaktu
custom_fields	custom_fields	array of object	Pole id a hodnot vlastních polí definovaných pro tento kontakt
identifikační číslo	custom_fields.id	string	Guid odkazující na vlastní pole
value	custom_fields.value	string	Hodnota tohoto vlastního pole tohoto kontaktu.
is_resolved	is_resolved	boolean	Jestli je konverzace s tímto kontaktem vyřešená. Všechny nové texty přijaté tímto kontaktem nastaví tuto hodnotu false.
first_contact_utc	first_contact_utc	string	Časové razítko odeslání první zprávy tomuto kontaktu.
opted_out_utc	opted_out_utc	string	Časové razítko, kdy se tento kontakt odhlásil k příjmu zpráv.
last_msg_sent_utc	last_msg_sent_utc	string	Časové razítko poslední zprávy odeslané tomuto kontaktu.
last_msg_received_utc	last_msg_received_utc	string	Časové razítko, kdy byla od tohoto kontaktu přijata poslední zpráva.
total_msgs_sent	total_msgs_sent	integer	Celkový počet zpráv odeslaných tomuto kontaktu
total_msgs_received	total_msgs_received	integer	Celkový počet zpráv přijatých od tohoto kontaktu
response_count	response_count	integer	Celkový počet zpráv odpovědí od kontaktu
date_created_utc	date_created_utc	string	Časové razítko vytvoření kontaktu.
last_contact_date_utc	last_contact_date_utc	string	Časové razítko, kdy byla od tohoto kontaktu odeslána nebo přijata poslední zpráva.
message_id	last_message.message_id	string	ID zprávy. Tato hodnota je jedinečná pro každou zprávu.
body	last_message.body	string	Obsah této zprávy
message_direction	last_message.message_direction	string	Jednoznamový znak, R nebo S, označující, zda byla tato zpráva přijata od kontaktu nebo odeslána jim, v uvedeném pořadí.
response_by_username	last_message.response_by_username	string	Uživatelské jméno uživatele textové žádosti, který naposledy odeslal zprávu tomuto uživateli.
message_timestamp_utc	last_message.message_timestamp_utc	string	Časové razítko, kdy byla zpráva odeslána nebo přijata textovým požadavkem.
delivery_status	last_message.delivery_status	string	Aktuální stav této zprávy Může se jednat o odesílání, doručení, chybu nebo odeslání.
delivery_error	last_message.delivery_error	string	Chyba, která způsobila nedoručovat tuto zprávu. Pokud delivery_status není chyba, bude tato hodnota null.
mms_media	last_message.mms_media	array of string	Seznam adres URL odkazující na přílohy této zprávy Všechny adresy URL budou generované textovou adresou URL.

Vytvoření nového řídicího panelu se zadaným jménem a telefonním číslem

ID operace:

CreateDashboard

Vytvoří nový řídicí panel v účtu. Po vytvoření řídicího panelu budou správci o změně e-mailem a můžou začít přiřazovat uživatele. Tento koncový bod může vytvořit řídicí panel pro všechna zřízená čísla. Zřízená čísla můžete vyhledat v určitém směrovém kódu oblasti pomocí funkce GET /dashboards/provisioning. Pokud je telefonní číslo již používáno, vyvolá se výjimka Chybný požadavek.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
název	name		string	Název řídicího panelu
telefon	phone		string	Textové číslo přidružené k tomuto řídicímu panelu.

Návraty

Name	Cesta	Typ	Description
identifikační číslo	id	integer	Číselné ID řídicího panelu.
název	name	string	Název řídicího panelu
telefon	phone	string	Textové číslo přidružené k tomuto řídicímu panelu.

Vytvoří novou platbu.

ID operace:

CreatePayment

Vytvoří novou platbu s poskytnutou zprávou poskytnutému kontaktu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.
Popis platby	description		string	Popis platby. Popis se kontaktu nezobrazuje a používá ho jenom interní uživatelé pro kontext plateb.
Telefonní číslo příjemce	customer_phone		string	Telefonní číslo kontaktu, na který bude tato platba odeslána.
Částka požadovaná v dolarech	amount_requested		float	Částka v dolarech požadovaných touto platbou.
Text zprávy platby	message		string	Text zprávy pro odeslání kontaktu spolu s odkazem na platbu
Referenční řetězec platby	reference_number		string	ID definované uživatelem definované při vytváření plateb, které se dají použít k rychlému vyhledání plateb. Referenční čísla nejsou jedinečná; mnoho plateb může mít stejný odkaz.

Návraty

Name	Cesta	Typ	Description
payment_id	payment_id	integer	Číselné ID platby.
request_date	request_date	string	Časové razítko, kdy byla počáteční zpráva této platby zařazena do fronty k odeslání.
příjemce	recipient	string	Jméno příjemce platby. Tato hodnota může mít hodnotu null, pokud kontakt nemá přidružené jméno ke svému telefonnímu číslu.
popis	description	string	Popis platby. Tento kontakt se nezobrazuje. Používá ho pouze interní uživatelé pro kontext plateb.
customer_phone	customer_phone	string	Telefonní číslo kontaktu, který tuto platbu posílá.
amount_requested	amount_requested	float	Částka v dolarech požadovaných touto platbou.
is_past_due	is_past_due	boolean	Určuje, jestli je tato platba za datem žádosti.
reminder_was_sent	reminder_was_sent	boolean	Jestli už byla pro tuto platbu odeslána textová připomenutí.
transaction_status	transaction_status	string	Stav transakce v authvia. Tato hodnota začíná jako Neznámá.
textrequest_payment_status	textrequest_payment_status	string	Stav transakce v textovém požadavku. To představuje stav zobrazený na stránce plateb v aplikaci Text Request. Spustí se jako Odeslaná.
reference_number	reference_number	string	ID definované uživatelem definované při vytváření plateb, které se dají použít k rychlému vyhledání plateb. Referenční čísla nejsou jedinečná; mnoho plateb může mít stejný odkaz.

Vytvoří novou skupinu.

ID operace:

CreateGroup

Vytvoří novou skupinu se zadaným názvem.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.
Název skupiny	name		string	Nový název skupiny.
Poznámka ke skupině	notes		string	Krátká fráze popisující skupinu Používá se pro usnadnění.

Návraty

Name	Cesta	Typ	Description
identifikační číslo	id	integer	Číselné ID skupiny.
group_member_count	group_member_count	integer	Početčlenůch
is_keyword	is_keyword	boolean	Wheter tato skupina je skupina klíčových slov. Tyto skupiny se automaticky vygenerují, když uživatel nastaví klíčové slovo. Kontakty se při registraci automaticky přidají.
název	name	string	Název této skupiny.
poznámky	notes	string	Všechny poznámky k této skupině.
last_message_sent_utc	last_message_sent_utc	string	Časové razítko, kdy byla pro tuto skupinu odeslána poslední zpráva skupiny.

Zrušení archivace konverzace

ID operace:

UnarchiveConversation

Unarchives a conversation. Jakmile bude konverzace nearchivovaná, zobrazí se znovu ve frontě. zobrazí se také v konverzacích vrácených koncovým bodem /conversations. Pokud je konverzace již nearchivována, tato metoda nemá žádný vliv.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.
Telefonní číslo konverzace	phone_number	True	string	Telefonní číslo konverzace, která se má archivovat.

Návraty

response

string

Zruší zadanou platbu.

ID operace:

CancelPayment

Zruší zadanou platbu a odešle text uživatele, který platbu zrušil. Platby nelze upravit, takže zrušení a vystavení nové platby je nejlepší způsob, jak opravit platbu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.
ID platby	payment_id	True	integer	Číselné ID platby, která se má aktualizovat.

Návraty

Name	Cesta	Typ	Description
payment_id	payment_id	integer	Číselné ID platby.
request_date	request_date	string	Časové razítko, kdy byla počáteční zpráva této platby zařazena do fronty k odeslání.
příjemce	recipient	string	Jméno příjemce platby. Tato hodnota může mít hodnotu null, pokud kontakt nemá přidružené jméno ke svému telefonnímu číslu.
popis	description	string	Popis platby. Tento kontakt se nezobrazuje. Používá ho pouze interní uživatelé pro kontext plateb.
customer_phone	customer_phone	string	Telefonní číslo kontaktu, který tuto platbu posílá.
amount_requested	amount_requested	float	Částka v dolarech požadovaných touto platbou.
is_past_due	is_past_due	boolean	Určuje, jestli je tato platba za datem žádosti.
reminder_was_sent	reminder_was_sent	boolean	Jestli už byla pro tuto platbu odeslána textová připomenutí.
transaction_status	transaction_status	string	Stav transakce v authvia. Tato hodnota začíná jako Neznámá.
textrequest_payment_status	textrequest_payment_status	string	Stav transakce v textovém požadavku. To představuje stav zobrazený na stránce plateb v aplikaci Text Request. Spustí se jako Odeslaná.
reference_number	reference_number	string	ID definované uživatelem definované při vytváření plateb, které se dají použít k rychlému vyhledání plateb. Referenční čísla nejsou jedinečná; mnoho plateb může mít stejný odkaz.

Získá kontakt se zadaným telefonním číslem.

ID operace:

GetContactByPhoneNumber

Získá kontakt se zadaným telefonním číslem.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.
Telefonní číslo kontaktu	phone_number	True	string	Telefonní číslo kontaktu, který chcete získat.

Návraty

Name	Cesta	Typ	Description
telefonní číslo	phone_number	string	Telefonní číslo tohoto kontaktu.
first_name	first_name	string	Jméno tohoto kontaktu.
last_name	last_name	string	Příjmení tohoto kontaktu.
display_name	display_name	string	Celé jméno tohoto kontaktu. Toto je výchozí název zobrazovaný ve webové aplikaci při prohlížení kontaktů.
is_suppressed	is_suppressed	boolean	Jestli je konverzace s tímto kontaktem potlačena, a proto se při přijetí nepřesune do horní části fronty zpráv.
is_archived	is_archived	boolean	Zda je konverzace s tímto kontaktem archivována, a proto se při dotazování konverzací (ve výchozím nastavení) nedá zobrazit.
is_blocked	is_blocked	boolean	Bez ohledu na to, jestli je konverzace s tímto kontaktem blokovaná, a proto není přijatá nebo uložená.
suppressed_reason	suppressed_reason	string	Fráze popisující důvod potlačení kontaktu Pokud je is_suppressed false, bude mít hodnotu null.
poznámka	note	string	Krátká fráze popisující kontakt Používá se pro usnadnění. Tento kontakt se nikdy nezobrazuje.
groups	groups	array of integer	Pole celočíselových ID odkazujících na skupiny, do nichž tento kontakt patří.
contact_tags	contact_tags	array of string	Pole guid odkazujících na značky připojené k tomuto kontaktu
custom_fields	custom_fields	array of object	Pole id a hodnot vlastních polí definovaných pro tento kontakt
identifikační číslo	custom_fields.id	string	Guid odkazující na vlastní pole
value	custom_fields.value	string	Hodnota tohoto vlastního pole tohoto kontaktu.
is_resolved	is_resolved	boolean	Jestli je konverzace s tímto kontaktem vyřešená. Všechny nové texty přijaté tímto kontaktem nastaví tuto hodnotu false.
first_contact_utc	first_contact_utc	string	Časové razítko odeslání první zprávy tomuto kontaktu.
opted_out_utc	opted_out_utc	string	Časové razítko, kdy se tento kontakt odhlásil k příjmu zpráv.
last_msg_sent_utc	last_msg_sent_utc	string	Časové razítko poslední zprávy odeslané tomuto kontaktu.
last_msg_received_utc	last_msg_received_utc	string	Časové razítko, kdy byla od tohoto kontaktu přijata poslední zpráva.
total_msgs_sent	total_msgs_sent	integer	Celkový počet zpráv odeslaných tomuto kontaktu
total_msgs_received	total_msgs_received	integer	Celkový počet zpráv přijatých od tohoto kontaktu
response_count	response_count	integer	Celkový počet zpráv odpovědí od kontaktu.
date_created_utc	date_created_utc	string	Časové razítko vytvoření kontaktu.
last_contact_date_utc	last_contact_date_utc	string	Časové razítko odeslání nebo přijetí poslední zprávy od tohoto kontaktu.
message_id	last_message.message_id	string	ID zprávy. Tato hodnota je jedinečná pro každou zprávu.
body	last_message.body	string	Obsah této zprávy
message_direction	last_message.message_direction	string	Jednoznamový znak, R nebo S, označující, zda byla tato zpráva přijata od kontaktu nebo odeslána jim, v uvedeném pořadí.
response_by_username	last_message.response_by_username	string	Uživatelské jméno uživatele textové žádosti, který naposledy odeslal zprávu tomuto uživateli.
message_timestamp_utc	last_message.message_timestamp_utc	string	Časové razítko, kdy byla zpráva odeslána nebo přijata textovým požadavkem.
delivery_status	last_message.delivery_status	string	Aktuální stav této zprávy Může se jednat o odesílání, doručení, chybu nebo odeslání.
delivery_error	last_message.delivery_error	string	Chyba, která způsobila nedoručovat tuto zprávu. Pokud delivery_status není chyba, bude tato hodnota null.
mms_media	last_message.mms_media	array of string	Seznam adres URL odkazující na přílohy této zprávy Všechny adresy URL budou generované textovou adresou URL.

Získá platbu se zadaným ID.

ID operace:

GetPayment

Získá platbu se zadaným ID.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.
ID platby	payment_id	True	integer	Číselné ID platby, které chcete získat.

Návraty

Name	Cesta	Typ	Description
payment_id	payment_id	integer	Číselné ID platby.
request_date	request_date	string	Časové razítko, kdy byla počáteční zpráva této platby zařazena do fronty k odeslání.
příjemce	recipient	string	Jméno příjemce platby. Tato hodnota může mít hodnotu null, pokud kontakt nemá přidružené jméno ke svému telefonnímu číslu.
popis	description	string	Popis platby. Tento kontakt se nezobrazuje. Používá ho pouze interní uživatelé pro kontext plateb.
customer_phone	customer_phone	string	Telefonní číslo kontaktu, který tuto platbu posílá.
amount_requested	amount_requested	float	Částka v dolarech požadovaných touto platbou.
is_past_due	is_past_due	boolean	Určuje, jestli je tato platba za datem žádosti.
reminder_was_sent	reminder_was_sent	boolean	Jestli už byla pro tuto platbu odeslána textová připomenutí.
transaction_status	transaction_status	string	Stav transakce v authvia. Tato hodnota začíná jako Neznámá.
textrequest_payment_status	textrequest_payment_status	string	Stav transakce v textovém požadavku. To představuje stav zobrazený na stránce plateb v aplikaci Text Request. Spustí se jako Odeslaná.
reference_number	reference_number	string	ID definované uživatelem definované při vytváření plateb, které se dají použít k rychlému vyhledání plateb. Referenční čísla nejsou jedinečná; mnoho plateb může mít stejný odkaz.

Získá všechna vlastní pole.

ID operace:

GetCustomFields

Získá všechna vlastní pole pro tento řídicí panel. Vlastní pole jsou mezi řídicími panely jedinečná.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.

Návraty

Name	Cesta	Typ	Description
		array of object
identifikační číslo	id	string	Číselné ID pole.
název	name	string	Název vlastního pole

Získá všechny konverzace pro tento řídicí panel.

ID operace:

GetConversations

Získá všechny konverzace pro tento řídicí panel a obsahuje informace o poslední zprávě pro každou konverzaci.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Značky kontaktů	tags		string	Čárkami oddělený seznam identifikátorů GUID odkazující na značky pro filtrování konverzací podle.
Jestli se mají zobrazovat jenom vyřešené konverzace	show_unresolved_only		string	Zda se mají hledat jenom kontakty, jejichž konverzace byly vyřešeny. Pokud je tato hodnota false, zobrazí se vyřešené i nevyřešené konverzace.
Zda zahrnout archivované konverzace	include_archived		string	Zda zahrnout konverzace s kontakty, které byly archivovány.
Termín pro filtrování podle telefonních čísel a jména kontaktu	search		string	Hledaný termín pro filtrování konverzací podle telefonního čísla nebo zobrazovaného jména Pokud je hledaný termín menší než celé jméno nebo telefonní číslo, vrátí hledání všechny konverzace, které částečně odpovídají hledanému výrazu.
Číslo stránky, která se má získat	page		integer	Stránka entit, které se mají získat. Při získávání hodnot je maximální velikost na stránku definovaná page_size. Pokud je stránka větší než poslední stránka, vrátí se prázdné pole.
Množství každé entity, která se má získat na stránku	page_size		integer	Velikost každé stránky, která se má získat. Při získávání hodnot se jedná o maximální velikost na stránku s přístupem k následným stránkám provedeným parametrem stránky.
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.

Návraty

Name	Cesta	Typ	Description
page	meta.page	integer	Stránka entit se dostala. Množství entit na této stránce je definováno page_size.
page_size	meta.page_size	integer	Počet entit, které se na této stránce dostaly
total_items	meta.total_items	integer	Počet entit dostupných v databázi bez ohledu na velikost nebo číslo stránky. Pokud chcete zobrazit další stránky, změňte číslo stránky v požadavku.
items	items	array of object	Seznam entit konverzace, které se dostaly z žádosti o text
telefonní číslo	items.phone_number	string	Telefonní číslo kontaktu.
message_id	items.last_message.message_id	string	ID zprávy. Tato hodnota je jedinečná pro každou zprávu.
body	items.last_message.body	string	Obsah této zprávy
message_direction	items.last_message.message_direction	string	Jednoznamový znak, R nebo S, označující, zda byla tato zpráva přijata od kontaktu nebo odeslána jim, v uvedeném pořadí.
response_by_username	items.last_message.response_by_username	string	Uživatelské jméno uživatele textové žádosti, který naposledy odeslal zprávu tomuto uživateli.
message_timestamp_utc	items.last_message.message_timestamp_utc	string	Časové razítko, kdy byla zpráva odeslána nebo přijata textovým požadavkem.
delivery_status	items.last_message.delivery_status	string	Aktuální stav této zprávy Může se jednat o odesílání, doručení, chybu nebo odeslání.
delivery_error	items.last_message.delivery_error	string	Chyba, která způsobila nedoručovat tuto zprávu. Pokud delivery_status není chyba, bude tato hodnota null.
mms_media	items.last_message.mms_media	array of string	Seznam adres URL odkazující na přílohy této zprávy Všechny adresy URL budou generované textovou adresou URL.

Získá všechny platby.

ID operace:

GetPayments

Získá všechny platby, včetně zrušených a placených plateb. Ty je možné filtrovat pomocí parametrů dotazu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Referenční řetězec platby	reference_number		string	ID definované uživatelem definované při vytváření plateb, které se dají použít k rychlému vyhledání plateb. Referenční čísla nejsou jedinečná; mnoho plateb může mít stejný odkaz.
Telefonní číslo platby	phone_number		string	Telefonní číslo kontaktu, na který byla tato platba odeslána.
Seřadit podle	sort_type		string	Vlastnost pro řazení plateb podle. Může to být "amount", "contact", "date", "status".
Směr řazení	sort_direction		string	Směr řazení plateb. Může být "desc" pro největší až nejmenší, nebo "asc" pro nejmenší až největší.
Číslo stránky, která se má získat	page	True	integer	Stránka entit, které se mají získat. Při získávání hodnot je maximální velikost na stránku definovaná page_size. Pokud je stránka větší než poslední stránka, vrátí se prázdné pole.
Množství každé entity, která se má získat na stránku	page_size	True	integer	Velikost každé stránky, která se má získat. Při získávání hodnot se jedná o maximální velikost na stránku s přístupem k následným stránkám provedeným parametrem stránky.
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.

Návraty

Name	Cesta	Typ	Description
page	meta.page	integer	Stránka entit se dostala. Množství entit na této stránce je definováno page_size.
page_size	meta.page_size	integer	Počet entit, které se na této stránce dostaly
total_items	meta.total_items	integer	Počet entit dostupných v databázi bez ohledu na velikost nebo číslo stránky. Pokud chcete zobrazit další stránky, změňte číslo stránky v požadavku.
items	items	array of object	Seznamplatebníchch
payment_id	items.payment_id	integer	Číselné ID platby.
request_date	items.request_date	string	Časové razítko, kdy byla počáteční zpráva této platby zařazena do fronty k odeslání.
příjemce	items.recipient	string	Jméno příjemce platby. Tato hodnota může mít hodnotu null, pokud kontakt nemá přidružené jméno ke svému telefonnímu číslu.
popis	items.description	string	Popis platby. Tento kontakt se nezobrazuje. Používá ho pouze interní uživatelé pro kontext plateb.
customer_phone	items.customer_phone	string	Telefonní číslo kontaktu, který tuto platbu posílá.
amount_requested	items.amount_requested	float	Částka v dolarech požadovaných touto platbou.
is_past_due	items.is_past_due	boolean	Určuje, jestli je tato platba za datem žádosti.
reminder_was_sent	items.reminder_was_sent	boolean	Jestli už byla pro tuto platbu odeslána textová připomenutí.
transaction_status	items.transaction_status	string	Stav transakce v authvia. Tato hodnota začíná jako Neznámá.
textrequest_payment_status	items.textrequest_payment_status	string	Stav transakce v textovém požadavku. To představuje stav zobrazený na stránce plateb v aplikaci Text Request. Spustí se jako Odeslaná.
reference_number	items.reference_number	string	ID definované uživatelem definované při vytváření plateb, které se dají použít k rychlému vyhledání plateb. Referenční čísla nejsou jedinečná; mnoho plateb může mít stejný odkaz.

Získá všechny skupiny.

ID operace:

GetGroups

Získá všechny skupiny pro účet uživatele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Číslo stránky, která se má získat	page	True	integer	Stránka entit, které se mají získat. Při získávání hodnot je maximální velikost na stránku definovaná page_size. Pokud je stránka větší než poslední stránka, vrátí se prázdné pole.
Množství každé entity, která se má získat na stránku	page_size	True	integer	Velikost každé stránky, která se má získat. Při získávání hodnot se jedná o maximální velikost na stránku s přístupem k následným stránkám provedeným parametrem stránky.
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.

Návraty

Name	Cesta	Typ	Description
page	meta.page	integer	Stránka entit se dostala. Množství entit na této stránce je definováno page_size.
page_size	meta.page_size	integer	Počet entit, které se na této stránce dostaly
total_items	meta.total_items	integer	Počet entit dostupných v databázi bez ohledu na velikost nebo číslo stránky. Pokud chcete zobrazit další stránky, změňte číslo stránky v požadavku.
items	items	array of object	Seznam entit skupiny, které se dostaly z žádosti o text
identifikační číslo	items.id	integer	Číselné ID skupiny.
group_member_count	items.group_member_count	integer	Početčlenůch
is_keyword	items.is_keyword	boolean	Wheter tato skupina je skupina klíčových slov. Tyto skupiny se automaticky vygenerují, když uživatel nastaví klíčové slovo. Kontakty se při registraci automaticky přidají.
název	items.name	string	Název této skupiny.
poznámky	items.notes	string	Všechny poznámky k této skupině.
last_message_sent_utc	items.last_message_sent_utc	string	Časové razítko, kdy byla pro tuto skupinu odeslána poslední zpráva skupiny.

Získá všechny značky

ID operace:

GetTags

Získá všechny značky pro tento řídicí panel. Značky jsou mezi řídicími panely jedinečné.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.
Číslo stránky, která se má získat	page	True	integer	Stránka entit, které se mají získat. Při získávání hodnot je maximální velikost na stránku definovaná page_size. Pokud je stránka větší než poslední stránka, vrátí se prázdné pole.
Množství každé entity, která se má získat na stránku	page_size	True	integer	Velikost každé stránky, která se má získat. Při získávání hodnot se jedná o maximální velikost na stránku s přístupem k následným stránkám provedeným parametrem stránky.

Návraty

Name	Cesta	Typ	Description
page	meta.page	integer	Stránka entit se dostala. Množství entit na této stránce je definováno page_size.
page_size	meta.page_size	integer	Počet entit, které se na této stránce dostaly
total_items	meta.total_items	integer	Počet entit dostupných v databázi bez ohledu na velikost nebo číslo stránky. Pokud chcete zobrazit další stránky, změňte číslo stránky v požadavku.
items	items	array of object	Seznam entit značek, které se získaly z textového požadavku
identifikační číslo	items.id	string	Číselné ID značky.
tag_color	items.tag_color	string	Barva značky Mělo by se jednat o platný šestnáctkový kód barvy.
klíčové slovo	items.tag	string	Název značky.

Získání informací o tomto konkrétním řídicím panelu

ID operace:

GetDashboard

Vrátí název a telefon řídicího panelu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.

Návraty

Name	Cesta	Typ	Description
identifikační číslo	id	integer	Číselné ID řídicího panelu.
název	name	string	Název řídicího panelu
telefon	phone	string	Textové číslo přidružené k tomuto řídicímu panelu.

Získání skupiny podle id

ID operace:

GetGroupById

Získá skupinu se zadaným ID.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.
ID skupiny	group_id	True	integer	Číselné ID skupiny, které chcete získat.

Návraty

Name	Cesta	Typ	Description
identifikační číslo	id	integer	Číselné ID skupiny.
group_member_count	group_member_count	integer	Početčlenůch
is_keyword	is_keyword	boolean	Wheter tato skupina je skupina klíčových slov. Tyto skupiny se automaticky vygenerují, když uživatel nastaví klíčové slovo. Kontakty se při registraci automaticky přidají.
název	name	string	Název této skupiny.
poznámky	notes	string	Všechny poznámky k této skupině.
last_message_sent_utc	last_message_sent_utc	string	Časové razítko, kdy byla pro tuto skupinu odeslána poslední zpráva skupiny.

Získání všech kontaktů, které odpovídají zadanému kritériu filtrování

ID operace:

GetContacts

Získá všechny kontakty, které odpovídají zadanému kritériu filtrování. Prohledá se pouze zadaný řídicí panel; není k dispozici žádné vyhledávání na úrovni účtu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Telefonní číslo kontaktu, podle které chcete hledat	contact_phone_number		string	Telefonní číslo pro filtrování kontaktů podle.
Časové razítko hledání last-message-time sent before (Čas poslední zprávy odeslaná před) v čase UTC	last_message_timestamp_before_utc		date-time	Přímá doba hledání kontaktů podle poslední odeslané nebo přijaté zprávy. Nezobrazí se žádné kontakty, které po této době odesílaly zprávy.
Časové razítko hledání Last-message-time sent after (Čas poslední zprávy odeslaná po) v čase UTC	last_message_timestamp_after_utc		date-time	Přímá doba hledání kontaktů podle poslední odeslané nebo přijaté zprávy. Nebudou zobrazeny žádné kontakty, jejichž poslední odeslaná zpráva je před touto dobou.
Časové razítko hledání Vytvořené před	contact_created_before		date-time	Časový limit pro vyhledávání kontaktů podle toho, kdy byly vytvořeny. Po tomto okamžiku se nezobrazí žádné kontakty vytvořené.
Časové razítko hledání Vytvořené po	contact_created_after		date-time	Časový limit pro vyhledávání kontaktů podle toho, kdy byly vytvořeny. Nezobrazí se žádné kontakty vytvořené před tímto časem.
Jestli je konverzace kontaktu vyřešená	is_resolved		boolean	Zda se mají hledat kontakty, jejichž konverzace byly vyřešeny.
Jestli je kontakt zablokovaný	is_blocked		boolean	Jestli se mají hledat kontakty, které byly blokované.
Zda je kontakt archivován	is_archived		boolean	Zda se mají hledat kontakty, které byly archivovány.
Jestli je kontakt potlačen	is_suppressed		boolean	Zda se mají hledat kontakty, které byly potlačeny.
Jestli se kontakt odhlásil	has_opted_out		boolean	Zda chcete vyhledat kontakty, které se odhlásily od přijímání textů.
Časové razítko hledání Last-message-time sent before	last_message_sent_before		date-time	Časový limit pro vyhledávání kontaktů do doby, kdy byla poslední zpráva odeslána zákazníkovi. Nezobrazí se žádné kontakty, které po této době odesílaly zprávy. Používá časové razítko jako místní čas. K filtrování podle časového razítka v čase UTC použijte last_message_sent_before_utc
Časové razítko hledání Last-message-time sent after	last_message_sent_after		date-time	Časový limit pro vyhledávání kontaktů do doby, kdy byla poslední zpráva odeslána zákazníkovi. Nebudou zobrazeny žádné kontakty, jejichž poslední odeslaná zpráva je před touto dobou. Používá časové razítko jako místní čas. K filtrování podle časového razítka v čase UTC použijte last_message_sent_after_utc
Časové razítko hledání "Naposledy přijatý čas zprávy"	last_message_received_before		date-time	Přímá doba hledání kontaktů podle poslední zprávy přijaté od zákazníka Nezobrazí se žádné kontakty, které po této době obdržely zprávy. Používá časové razítko jako místní čas. K filtrování podle časového razítka v čase UTC použijte last_message_sent_before_utc
Časové razítko hledání Last-message-time received after	last_message_received_after		date-time	Přímá doba hledání kontaktů podle poslední zprávy přijaté od zákazníka Nebudou zobrazeny žádné kontakty, jejichž poslední odeslaná zpráva je před touto dobou. Používá časové razítko jako místní čas. K filtrování podle časového razítka v čase UTC použijte last_message_sent_before_utc
Značky kontaktů	tags		string	Čárkami oddělený seznam identifikátorů GUID odkazující na značky pro filtrování kontaktů podle.
Skupiny kontaktů	groups		string	Čárkami oddělený seznam celočíselových ID odkazujících na skupiny pro filtrování kontaktů podle.
ID vlastního pole pro filtrování podle	custom_field_id_1		string	Guid odkazující na vlastní pole pro filtrování kontaktů podle.
Hodnota vlastního pole pro filtrování podle	custom_field_value_1		string	Hodnota odkazující na vlastní pole pro filtrování kontaktů podle.
ID druhého vlastního pole pro filtrování podle	custom_field_id_2		string	Guid odkazující na druhé vlastní pole pro filtrování kontaktů podle.
Hodnota druhého vlastního pole pro filtrování podle	custom_field_value_2		string	Hodnota odkazující na druhé vlastní pole pro filtrování kontaktů podle.
ID třetího vlastního pole pro filtrování podle	custom_field_id_3		string	Guid odkazující na třetí vlastní pole pro filtrování kontaktů podle.
Hodnota třetího vlastního pole pro filtrování podle	custom_field_value_3		string	Hodnota odkazující na třetí vlastní pole pro filtrování kontaktů podle.
Číslo stránky, která se má získat	page	True	integer	Stránka entit, které se mají získat. Při získávání hodnot je maximální velikost na stránku definovaná page_size. Pokud je stránka větší než poslední stránka, vrátí se prázdné pole.
Množství každé entity, která se má získat na stránku	page_size	True	integer	Velikost každé stránky, která se má získat. Při získávání hodnot se jedná o maximální velikost na stránku s přístupem k následným stránkám provedeným parametrem stránky.
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.

Návraty

Name	Cesta	Typ	Description
page	meta.page	integer	Stránka entit se dostala. Množství entit na této stránce je definováno page_size.
page_size	meta.page_size	integer	Počet entit, které se na této stránce dostaly
total_items	meta.total_items	integer	Počet entit dostupných v databázi bez ohledu na velikost nebo číslo stránky. Pokud chcete zobrazit další stránky, změňte číslo stránky v požadavku.
items	items	array of object	Seznam entit kontaktů, které se dostaly z textové žádosti
telefonní číslo	items.phone_number	string	Telefonní číslo tohoto kontaktu.
first_name	items.first_name	string	Jméno tohoto kontaktu.
last_name	items.last_name	string	Příjmení tohoto kontaktu.
display_name	items.display_name	string	Celé jméno tohoto kontaktu. Toto je výchozí název zobrazovaný ve webové aplikaci při prohlížení kontaktů.
is_suppressed	items.is_suppressed	boolean	Jestli je konverzace s tímto kontaktem potlačena, a proto se při přijetí nepřesune do horní části fronty zpráv.
is_archived	items.is_archived	boolean	Zda je konverzace s tímto kontaktem archivována, a proto se při dotazování konverzací (ve výchozím nastavení) nedá zobrazit.
is_blocked	items.is_blocked	boolean	Bez ohledu na to, jestli je konverzace s tímto kontaktem blokovaná, a proto není přijatá nebo uložená.
suppressed_reason	items.suppressed_reason	string	Fráze popisující důvod potlačení kontaktu Pokud je is_suppressed false, bude mít hodnotu null.
poznámka	items.note	string	Krátká fráze popisující kontakt Používá se pro usnadnění. Tento kontakt se nikdy nezobrazuje.
groups	items.groups	array of integer	Pole celočíselových ID odkazujících na skupiny, do nichž tento kontakt patří.
contact_tags	items.contact_tags	array of string	Pole guid odkazujících na značky připojené k tomuto kontaktu
custom_fields	items.custom_fields	array of object	Pole id a hodnot vlastních polí definovaných pro tento kontakt
identifikační číslo	items.custom_fields.id	string	Guid odkazující na vlastní pole
value	items.custom_fields.value	string	Hodnota tohoto vlastního pole tohoto kontaktu.
is_resolved	items.is_resolved	boolean	Jestli je konverzace s tímto kontaktem vyřešená. Všechny nové texty přijaté tímto kontaktem nastaví tuto hodnotu false.
first_contact_utc	items.first_contact_utc	string	Časové razítko odeslání první zprávy tomuto kontaktu.
opted_out_utc	items.opted_out_utc	string	Časové razítko, kdy se tento kontakt odhlásil k příjmu zpráv.
last_msg_sent_utc	items.last_msg_sent_utc	string	Časové razítko poslední zprávy odeslané tomuto kontaktu.
last_msg_received_utc	items.last_msg_received_utc	string	Časové razítko, kdy byla od tohoto kontaktu přijata poslední zpráva.
total_msgs_sent	items.total_msgs_sent	integer	Celkový počet zpráv odeslaných tomuto kontaktu
total_msgs_received	items.total_msgs_received	integer	Celkový počet zpráv přijatých od tohoto kontaktu
response_count	items.response_count	integer	Celkový počet zpráv odpovědí od kontaktu
date_created_utc	items.date_created_utc	string	Časové razítko vytvoření kontaktu.
last_contact_date_utc	items.last_contact_date_utc	string	Časové razítko, kdy byla od tohoto kontaktu odeslána nebo přijata poslední zpráva.
message_id	items.last_message.message_id	string	ID zprávy. Tato hodnota je jedinečná pro každou zprávu.
body	items.last_message.body	string	Obsah této zprávy
message_direction	items.last_message.message_direction	string	Jednoznamový znak, R nebo S, označující, zda byla tato zpráva přijata od kontaktu nebo odeslána jim, v uvedeném pořadí.
response_by_username	items.last_message.response_by_username	string	Uživatelské jméno uživatele textové žádosti, který naposledy odeslal zprávu tomuto uživateli.
message_timestamp_utc	items.last_message.message_timestamp_utc	string	Časové razítko, kdy byla zpráva odeslána nebo přijata textovým požadavkem.
delivery_status	items.last_message.delivery_status	string	Aktuální stav této zprávy Může se jednat o odesílání, doručení, chybu nebo odeslání.
delivery_error	items.last_message.delivery_error	string	Chyba, která způsobila nedoručovat tuto zprávu. Pokud delivery_status není chyba, bude tato hodnota null.
mms_media	items.last_message.mms_media	array of string	Seznam adres URL odkazující na přílohy této zprávy Všechny adresy URL budou generované textovou adresou URL.

Získání všech řídicích panelů v účtu

ID operace:

GetDashboards

Získá všechny řídicí panely v účtu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Číslo stránky, která se má získat	page		integer	Stránka entit, které se mají získat. Při získávání hodnot je maximální velikost na stránku definovaná page_size. Pokud je stránka větší než poslední stránka, vrátí se prázdné pole.
Množství každé entity, která se má získat na stránku	page_size		integer	Velikost každé stránky, která se má získat. Při získávání hodnot se jedná o maximální velikost na stránku s přístupem k následným stránkám provedeným parametrem stránky.

Návraty

Name	Cesta	Typ	Description
page	meta.page	integer	Stránka entit se dostala. Množství entit na této stránce je definováno page_size.
page_size	meta.page_size	integer	Počet entit, které se na této stránce dostaly
total_items	meta.total_items	integer	Počet entit dostupných v databázi bez ohledu na velikost nebo číslo stránky. Pokud chcete zobrazit další stránky, změňte číslo stránky v požadavku.
items	items	array of object	Seznam entit řídicího panelu, které se dostaly z textové žádosti
identifikační číslo	items.id	integer	Číselné ID řídicího panelu.
název	items.name	string	Název řídicího panelu
telefon	items.phone	string	Textové číslo přidružené k tomuto řídicímu panelu.

Získání zpráv konverzace podle telefonního čísla kontaktu

ID operace:

GetMessagesByContactPhone

Získejte konverzaci mezi zadaným řídicím panelem a telefonním číslem.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Číslo stránky, která se má získat	page	True	integer	Stránka entit, které se mají získat. Při získávání hodnot je maximální velikost na stránku definovaná page_size. Pokud je stránka větší než poslední stránka, vrátí se prázdné pole.
Množství každé entity, která se má získat na stránku	page_size	True	integer	Velikost každé stránky, která se má získat. Při získávání hodnot se jedná o maximální velikost na stránku s přístupem k následným stránkám provedeným parametrem stránky.
ID řídicího panelu, na který se má toto volání volat	dashboard_id	True	integer	Řídicí panel telefonního čísla, na který chcete pracovat. Jeden účet může mít několik řídicích panelů, které představují různé telefonní linky pro zákazníky.
Telefonní číslo kontaktu, podle které chcete hledat	phone_number	True	string	Telefonní číslo kontaktu, pro který chcete dostávat zprávy.

Návraty

Name	Cesta	Typ	Description
page	meta.page	integer	Stránka entit se dostala. Množství entit na této stránce je definováno page_size.
page_size	meta.page_size	integer	Počet entit, které se na této stránce dostaly
total_items	meta.total_items	integer	Počet entit dostupných v databázi bez ohledu na velikost nebo číslo stránky. Pokud chcete zobrazit další stránky, změňte číslo stránky v požadavku.
items	items	array of object	Seznam entit zpráv, které se dostaly z textové žádosti
message_id	items.message_id	string	ID zprávy. Tato hodnota je jedinečná pro každou zprávu.
body	items.body	string	Obsah této zprávy
message_direction	items.message_direction	string	Jednoznamový znak, R nebo S, označující, zda byla tato zpráva přijata od kontaktu nebo odeslána jim, v uvedeném pořadí.
response_by_username	items.response_by_username	string	Uživatelské jméno uživatele textové žádosti, který naposledy odeslal zprávu tomuto uživateli.
message_timestamp_utc	items.message_timestamp_utc	string	Časové razítko, kdy byla zpráva odeslána nebo přijata textovým požadavkem.
delivery_status	items.delivery_status	string	Aktuální stav této zprávy Může se jednat o odesílání, doručení, chybu nebo odeslání.
delivery_error	items.delivery_error	string	Chyba, která způsobila nedoručovat tuto zprávu. Pokud delivery_status není chyba, bude tato hodnota null.
mms_media	items.mms_media	array of string	Seznam adres URL odkazující na přílohy této zprávy Všechny adresy URL budou generované textovou adresou URL.

Aktivační události

Aktivuje se při odeslání nebo přijetí textu.

Aktivuje se při odeslání nebo přijetí textu.

Aktivuje se při odeslání nebo přijetí textu.

ID operace:

TextingWebhook

Aktivuje se při odeslání nebo přijetí textu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Řídicí panel, ze které trigger naslouchá událostem	dashboard_id	True	string	ID řídicího panelu pro přidání triggeru do
událost	event	True	string	událost

Návraty

Name	Cesta	Typ	Description
Jedinečné ID zprávy	messageUniqueIdentifier	string	messageUniqueIdentifier
ID účtu	account.id	integer	identifikační číslo
ID konverzace	yourPhoneNumber.id	integer	identifikační číslo
Název řídicího panelu	yourPhoneNumber.description	string	popis
Telefonní číslo řídicího panelu	yourPhoneNumber.phoneNumber	string	telefonní číslo
ID řídicího panelu	conversation.id	integer	identifikační číslo
date	conversation.date	string	date
Kontaktní telefonní číslo	conversation.consumerPhoneNumber	string	consumerPhoneNumber
messageDirection	conversation.messageDirection	string	messageDirection
zpráva	conversation.message	string	zpráva
numSegments	conversation.numSegments	integer	numSegments
stav	conversation.status	string	stav
Konverzace, o kterou požádal	conversation.claimedBy	string	claimedBy
Zobrazované jméno kontaktu	conversation.consumerFriendlyName	string	consumerFriendlyName

Definice

řetězec

Toto je základní datový typ String.