Szöveges kérelem

A Text Request egy üzleti szöveges platform, amely az ügyfélkapcsolatok meggyújtására készült. Létrehoztunk egy plug-and-play üzenetküldő megoldást a mindennapi kommunikációs problémákra, így bármikor és bárhol átvághatja a zajt, és kapcsolatba léphet az ügyfelekkel. További információ arról, hogyan segítünk az Önhez hasonló elfoglalt üzleti vezetőknek.

Ez az összekötő a következő termékekben és régiókban érhető el:

Service	Class	Régiók
Copilot Studio	prémium	Az összes Power Automate-régió, kivéve a következőket:      - USA kormánya (GCC)      - Amerikai kormány (GCC High)      - A 21Vianet által üzemeltetett China Cloud      - Amerikai Védelmi Minisztérium (DoD)
Logikai alkalmazások	Standard	Az összes Logic Apps-régió , kivéve a következőket:      - Azure Government-régiók      - Azure China-régiók      - Amerikai Védelmi Minisztérium (DoD)
Power Alkalmazások	prémium	Az összes Power Apps-régió , kivéve a következőket:      - USA kormánya (GCC)      - Amerikai kormány (GCC High)      - A 21Vianet által üzemeltetett China Cloud      - Amerikai Védelmi Minisztérium (DoD)
Power Automate	prémium	Az összes Power Automate-régió, kivéve a következőket:      - USA kormánya (GCC)      - Amerikai kormány (GCC High)      - A 21Vianet által üzemeltetett China Cloud      - Amerikai Védelmi Minisztérium (DoD)

Érintkezés
Név	Text Request API-támogatás
URL	https://www.textrequest.com/contact
Email	apidev@textrequest.com

Összekötő metaadatai
Kiadó	Szöveges kérelem
Webhely	https://www.textrequest.com/
Adatvédelmi irányelvek	https://www.textrequest.com/privacy-policy/
Kategóriák	Kommunikáció; Értékesítés és CRM

Aranda Service Management Suite (ASMS)

Növelje vállalata termelékenységét, és alakítsa át felhasználói élményét az Aranda Service Management Suite-tal, a több-bérlős megoldással, amely lehetővé teszi az üzleti folyamatok és szolgáltatások kezelését, integrálását és automatizálását. Létrehozhat, kereshet és frissíthet rekordokat az ASMS bármely munkaterületén (projektjében), beleértve többek között az incidenseket, a követelményeket és a módosításokat.

Pre-requisites

A folytatáshoz tartsa szem előtt a következő előfeltételeket:

• Az Aranda Service Management Suite (ASMS) előfizetése és példánya. Kezdje itt: https://arandasoft.com/
• Aktív Microsoft Power Automate-előfizetés prémium szintű összekötői képességekkel.

Hitelesítő adatok beszerzése

• A hitelesítés végrehajtásához használja az integrációs jogkivonatot. Az alábbi hivatkozáson információkat talál az integrációs jogkivonat beszerzéséről

Ismerkedés az összekötővel

1. Az Aranda Service Management Suite (ASMS) előfizetést igényel.

2. Az integrációs jogkivonat beszerzése

3. Kérje le az Aranda Service Management ASMS API (ApiAsms) példány URL-címét.

4. Hozzon létre kapcsolatot az Aranda Service Management Suite-összekötővel.

5. Válassza ki az összekötő által kínált alábbi függvények egyikét:

6. Az összekötő részletes dokumentációját lásd: https://docs.arandasoft.com/connectors

Ezt az összekötőt a következő esetekben használhatja:

1. A többi elérhető művelet mellett jegyeket hozhat létre, kereshet és frissíthet.
2. Szerezze be a jegy nyomon követhetőségét.
3. Töltse le a jegyhez kapcsolódó mellékleteket.
4. Tudásbáziscikkek keresése az Aranda Service Management Suite-ban.
5. Mellékletek letöltése tudásbáziscikkekből.
6. Konfigurációelemek (CI-k) létrehozása, keresése és frissítése.
7. Lehetővé teszi a szervezetek számára, hogy megoldják a belső támogatási kéréseiket, és felügyeljék és egyszerűsítsék a technikai problémamegoldási folyamatot.
8. Lehetővé teszi a kérelmezők és a támogatási ügynökök közötti kommunikáció nyomon követését.
9. Automatikus válaszokat kínálhat a kérelmezőknek a jegyük állapotáról való tájékoztatásához.

Sikeres válasz

Kód	Név	Description
200	OKÉ	A kérés sikeres volt
204	Nincs tartalom	Nem található adat a kérelemben

Gyakori hibák és jogorvoslatok

Kód	Név	Description	Solution
400	Hibás kérés	CriteriaNeedsSomeArguments	Ellenőrizze, hogy a keresési paraméterek nem üresek-e
400	Hibás kérés	InvalidAdditionalFieldId	Ellenőrizze, hogy a további mezők azonosítói helyesek-e
400	Hibás kérés	InvalidItemType	A kis- és nagybetűk típusa helytelen, módosítsa az esettípus azonosítóját
400	Hibás kérés	InvalidProjectId	A projektazonosító helytelen, módosítsa azt a projektazonosítót, amelyhez az esetet társítani fogja
400	Hibás kérés	InvalidStateId	Jegy létrehozásakor vagy frissítésekor ellenőrizze a hozzáadott állapotot
400	Hibás kérés	InvalidUploadType	Hiba történt egy fájl csatolásakor, kérjen segítséget egy rendszergazdától
400	Hibás kérés	RequestNeedsSomeArguments	Ellenőrizze a jegy kötelező mezőit, és adja hozzá a megfelelő értéket az összekötőben
400	Hibás kérés	SearchListIsRequired	Rendszergazdai segítség kérése
400	Hibás kérés	Paraméter neve: {Name parameter}	Ellenőrizze, hogy a hiba által említett tulajdonságok nem null értékűek-e
400	Hibás kérés	Null paraméter neve: {Name parameter}	Ellenőrizze, hogy a hiba által említett tulajdonságok nem null értékűek-e
400	Hibás kérés	ItemTypeIsRequired	Kis- és nagybetűk hozzáadása
400	Hibás kérés	ModelIdIsEmpty	Adja hozzá a modelId paramétert. Ez kötelező.
400	Hibás kérés	StateIdIsEmpty	Adja hozzá a stateId paramétert. Ez kötelező.
400	Hibás kérés	ServiceIdIsEmpty	Adja hozzá a serviceId paramétert. Ez kötelező.
400	Hibás kérés	CategoryIdIsEmpty	Adja hozzá a categoryId paramétert. Ez kötelező.
400	Hibás kérés	TypesListNeedsSomeArguments	A jegyek keresésekor hozzá kell adni az esettípust, és segítséget kell kérnie a rendszergazdától
400	Hibás kérés	"{PARAMETER_NAME}" AdditionalFieldIsRequired	A(z) "{PARAMETER_NAME}" további mező kötelező
400	Hibás kérés	ModelNotActive	Az esethez társított modell nem aktív
400	Hibás kérés	FailedToCloseTaskPendingCloseTasksPredecessors	Ha megpróbálja bezárni az esetet, és a szülőesetben függőben lévő tevékenységek vannak lezárva
400	Hibás kérés	Duplikáltobject	A Ci már létezik az adatbázisban
400	Hibás kérés	EmptyValue paraméter neve: {PARAMETER_NAME}	A(z) {PARAMETER_NAME} paraméter megadása kötelező
400	Hibás kérés	EmptyEnumeration Paraméter neve: {PARAMETER_NAME}	A(z) {PARAMETER_NAME} paraméter egy lista, és kötelező
403 hibakód	Tiltott	DoNotHavePermissionForThisAction	Engedélyek hozzárendelése a rendszergazdával

Kód	Név	Description	Solution
ötszáz	Belső szerverhiba		Rendszergazdai segítség kérése
ötszáz	Belső szerverhiba	FailureExportExcel	Rendszergazdai segítség kérése
ötszáz	Belső szerverhiba	FailureGetAdditionalFields	Rendszergazdai segítség kérése
ötszáz	Belső szerverhiba	FailureGetCategoriesByService	Rendszergazdai segítség kérése
ötszáz	Belső szerverhiba	FailureGetChangeFSC	Rendszergazdai segítség kérése
ötszáz	Belső szerverhiba	FailureGetFields	Rendszergazdai segítség kérése
ötszáz	Belső szerverhiba	FailureGetFieldsList	Rendszergazdai segítség kérése
ötszáz	Belső szerverhiba	FailureGetFiles	Rendszergazdai segítség kérése
ötszáz	Belső szerverhiba	FailureGetLookupValues	Rendszergazdai segítség kérése
ötszáz	Belső szerverhiba	FailureGetMailTemplates	Rendszergazdai segítség kérése
ötszáz	Belső szerverhiba	FailureGetModelByCategory	Rendszergazdai segítség kérése
ötszáz	Belső szerverhiba	FailureGetOperators	Rendszergazdai segítség kérése
ötszáz	Belső szerverhiba	FailureGetReassignmentReasons	Rendszergazdai segítség kérése
ötszáz	Belső szerverhiba	FailureGetSimilarItems	Rendszergazdai segítség kérése
ötszáz	Belső szerverhiba	FailureSearchQuickManagement	Rendszergazdai segítség kérése

GYIK

1. Hogyan lehet lekérni az összekötő különböző műveleteinek használatához szükséges attribútumok azonosítóit (pl. projekt, szolgáltatás, kategória, csoport, szakember)?

   Az azonosítók sokféleképpen kérhetők le:

   • Az Aranda Query Managerrel létrehozhat egy jelentést, amely lekérdezi az Aranda Service Management Suite (ASMS) táblát, ahol a szükséges adatok találhatók. Ha útmutatásra van szüksége a megoldás adatobjektumaihoz, látogasson el az alábbi hivatkozásra https://docs.arandasoft.com/docs/database.html , és azonosítsa az ASMS-telepítésnek megfelelő Aranda-adatbázis verzióját.
   • Ha helyszíni ASMS-telepítést használ, lekérdezheti azt az ASMS-táblát, ahol a szükséges adatok egy SQL-ügyfélen keresztül találhatók.
   • Az Aranda támogatási központon keresztül hozzon létre egy támogatási kérést az alábbi webhelyen található támogatási csatornákon keresztül.

2. Mi a csatolandó fájlok maximális mérete a "Melléklet hozzáadása" művelet használatakor?

   A maximális méret az ASMS-példány/-telepítés adott konfigurációjától függ. Kérdezze meg az ASMS rendszergazdáját.

3. Milyen adathozzáférési szintet igényel az a technikusi fiók, amelynek jogkivonatát az összekötő által megkövetelt ASMS-kapcsolat konfigurációjában használják?

   A hozzáférési szint megegyezik az ASMS-ben rendszeresen használt technikusi fiókkal. Más szóval az ASMS megfelelő technikusának szerepkörei és engedélyei alapján az adatok az összekötővel érhetők el.

4. El kell nevezni vagy egyidejűnek kell lennie annak a technikusi fióknak, amelynek jogkivonatát használni fogja az összekötőben?

   Mivel az összekötő óránként többször is hozzáfér a kapcsolódó ASMS-példányhoz, erősen ajánlott, hogy a fiók nevesített típus legyen.

5. Az összekötőt használó esetek létrehozása vagy módosítása ugyanazokat az adatérvényesítési szabályokat követi, mint az ASMS-felületen?

   Igen, ugyanazokat az érvényesítési szabályokat követi. Ha például egy adott projekthez, szolgáltatáshoz és kategóriához hoz létre esetet, ha natív és további mezőket kell kitölteni, ezekre az adatokra is szükség van az összekötőn keresztüli beküldéshez.

6. Használhatja az összekötőt az ASMS-példányokhoz felhőbeli és helyszíni környezetekben?

   Igen, az ASMS felhőalapú és helyszíni telepítéseiben is használható. Helyszíni telepítések esetén figyelembe kell vennie az ASMS-kiszolgáló és a Power Automate-környezet közötti kapcsolatot.

7. Van egy Power Automate-licencem, amely csak standard összekötők használatát teszi lehetővé. Használhatom az ASMS-összekötőt?

   Ez nem lehetséges, az ASMS-összekötő prémium típusú.

8. Olyan folyamatokat szeretnék létrehozni a Power Automate-ben, amelyek az ASMS eseményeiből indulnak ki (például egy eset létrehozásakor, amikor egy eset egy adott csoporthoz van rendelve). Használhat olyan eseményindítókat, amelyek az ASMS-ben bekövetkező eseményekből indulnak ki?

   Igen, lehetséges. A következő lépések ajánlottak:

   • Inicializáljon egy "HTTP-kérés fogadásakor" eseményindítót, és hozzon létre egy JSON-kérelemtörzs-sémát, amely tartalmazza az ASMS-től várhatóan érkező adatstruktúrát. Az eseményindító létrehozása után egy HTTP POST URL-címet (WebHook URL-címet) kap, amelyet az ASMS-példányban használhat. Ne felejtse el figyelembe venni a hitelesítési mechanizmust a WebHook URL-címének (például token) eléréséhez.
   • Hozzon létre egy üzleti szabályt az ASMS-ben azon feltételek halmazához, amelyek teljesülésekor a Power Automate-ben kezdeményezni kell a folyamatot. A szabályban műveletként válassza a "Webhook meghívása" lehetőséget, és a meghívás cél URL-címében adja meg a korábban beszerzett WebHook URL-címet, az elküldendő paramétereket és a kérés törzsét (amelynek meg kell felelnie a kérelem törzsének JSON-sémájának). Ha többet szeretne tudni arról, hogyan hívhat meg webhookot egy szabályból az ASMS-ben, látogasson el a következő hivatkozásra: Webhook szabály
   • Tesztelje a létrehozott szabályt, és ellenőrizze, hogy a rendszer http-kérést küld-e a WebHook URL-címére, és inicializálja a folyamatot a Power Automate-ben.

9. Meghívhatom az ASMS REST API-végpontokat a Power Automate folyamatainak műveleteiként?

   Igen, lehetséges. Használja a "HTTP" műveletet, és töltse ki a szükséges adatokat (többek között URI, Metódus, Fejlécek, Törzs).

Kapcsolat létrehozása

Az összekötő a következő hitelesítési típusokat támogatja:

Alapértelmezett	A kapcsolat létrehozásának paraméterei.	Minden régió	Nem osztható meg

Alapértelmezett

Alkalmazható: Minden régió

A kapcsolat létrehozásának paraméterei.

Ez nem megosztható kapcsolat. Ha a power app meg van osztva egy másik felhasználóval, a rendszer kérni fogja, hogy hozzon létre új kapcsolatot.

Név	Típus	Description	Kötelező
API-kulcs	securestring	Az API API-kulcsa	True

Szabályozási korlátok

Name	Hívások	Megújítási időszak
API-hívások kapcsolatonként	100	60 másodperc

Műveletek

A megadott azonosítóval rendelkező csoport törlése	Törli a megadott azonosítóval rendelkező csoportot. Ez akkor is sikeres lesz, ha vannak olyan partnerek, amelyek a csoport tagjai (a névjegyek nem törlődnek).
A megadott fizetés lemondása	Megszakítja a megadott fizetést, és sms-ben jelzi a felhasználónak, hogy a kifizetést visszavonták. A kifizetések nem szerkeszthetők, ezért a kifizetés kijavításának legjobb módja a lemondás és az új fizetés kiállítása.
A megadott irányítópult törlése	Törli a megadott irányítópultot.
A megadott szűrési feltételnek megfelelő összes partner lekérése	Lekéri a megadott szűrési feltételnek megfelelő összes névjegyet. A rendszer csak a megadott irányítópulton keres; nincs elérhető szám fiókszintű keresése.
Adott irányítópult nevének frissítése	Irányítópult frissítése. Ez nem módosítja az irányítópult telefonszámát. Ha új számot szeretne egy másik irányítópult névjegyeivel, létre kell hoznia egy új irányítópultot egy POST-tal, és tömeges exportálással/importálással kell hozzáadnia a névjegyeket.
Az összes egyéni mező lekérdezve	Lekéri az irányítópult összes egyéni mezőjét. Az egyéni mezők egyediek az irányítópultok között.
Az összes irányítópult lekérése egy fiókban	Lekéri az összes irányítópultot egy fiókban.
Beszélgetés archiválása	Archiválja a beszélgetést, és eltávolítja az összes beszélgetés lekérési végpontjának eredményéből. A beszélgetések automatikusan archiválatlanok lesznek, ha az ügyfél szöveget küld a szöveges kérelem számára, vagy ha a szöveges kérelem számából küld egy szöveget az ügyfélnek. A beszélgetések archiválása jó módszer arra, hogy eltávolítsa a zsúfoltságokat azokról az ügyfelekről, akikhez a jövőben nem tervez beszélni. Vegye figyelembe, hogy ha egy ügyfél a "STOP" üzenetben szöveget ír, hogy megakadályozza, hogy további SMS-üzeneteket küldjön nekik, a beszélgetés automatikusan archiválva lesz.
Beszélgetés archiválása	Egy beszélgetés archiválása. Ha egy beszélgetés archiválatlan, az ismét megjelenik az üzenetsorban. a /conversations végpont által visszaadott beszélgetésekben is megjelenik. Ha egy beszélgetés már nincs archiválva, ennek a módszernek nincs hatása.
Beszélgetés üzenetének lekérése egy partner telefonszámával	Kérje le a beszélgetést a megadott irányítópult és telefonszám között.
Csoport frissítése a megadott azonosítóval	A csoport nevének frissítése a csoport numerikus azonosítójával. Ha a megadott csoportazonosító nem létezik, a hívás sikertelen lesz.
Csoport lekérése az azonosító alapján	Lekéri a csoportot a megadott azonosítóval.
Fizetés megjelölése fizetősként	A fizetést "fizetősként" zárja be. Használja ezt a végpontot arra az esetre, ha a fizetés a fizetési kérelem portáltól eltérő módon történik. Ezzel bezárja a kifizetést, és hozzáadja annak összegét a statisztikákhoz. Ez a végpont nem szükséges a szöveges kérelemen keresztül küldött fizetési portálon keresztül fizetett kifizetésekhez; amely automatikusan megjelöli a kifizetést fizetősként.
Információk lekérése erről az adott irányítópultról	Az irányítópult nevét és telefonját adja vissza.
Küldjön egy követő szöveget, amely emlékezteti a felhasználót a megadott fizetés kifizetésére	Emlékeztetőt küld a partnernek a megadott fizetés kifizetéséhez. Az üzenet tartalma automatikusan létre lesz hozva. A levélszemét elkerülése érdekében fizetésenként csak egy emlékeztető küldhető
Lekéri a fizetést a megadott azonosítóval	Lekéri a fizetést a megadott azonosítóval.
Lekéri a megadott telefonszámmal rendelkező partnert	Lekéri a megadott telefonszámmal rendelkező partnert
Lekéri az irányítópult összes beszélgetését	Lekéri az irányítópult összes beszélgetését, és tartalmazza az egyes beszélgetések utolsó üzenetének adatait.
Lekéri az összes csoportot	Lekéri a felhasználó fiókjához tartozó összes csoportot.
Lekéri az összes címkét	Lekéri az irányítópult összes címkét. A címkék egyediek az irányítópultok között.
Lekéri az összes kifizetést	Lekéri az összes kifizetést, beleértve a lemondott és a fizetős kifizetéseket is. Ezek a lekérdezési paraméterekkel szűrhetők.
Névjegy létrehozása vagy frissítése	Létrehoz vagy frissít egy partnert (attól függően, hogy már létezik-e a megadott telefonszámmal).
Névjegyek tömeges frissítése	Csak a megadott irányítópulton lesznek hozzáadva névjegyek; a partnerek irányítópultok szerint vannak rendszerezve, és nincs elérhető szám fiókszintű keresése.
Törli a megadott telefonszámmal rendelkező partnert	Törli a megadott telefonszámmal rendelkező partnert
Új csoport létrehozása	Létrehoz egy új csoportot a megadott névvel.
Új fizetés létrehozása	Új fizetést hoz létre a megadott üzenettel a megadott partnernek.
Új irányítópult létrehozása a megadott névvel és telefonszámmal	Új irányítópultot hoz létre a fiókban. Az irányítópult létrehozása után a rendszergazdák e-mailben kapják meg a módosítást, és megkezdhetik a felhasználók hozzárendelését. Ez a végpont bármilyen kiépített számhoz létrehozhat irányítópultot. Egy adott területkódban kiépített számokat a GET /dashboards/provisioning használatával kereshet. Ha a telefonszám már használatban van, a rendszer egy hibás kérés kivételt küld.
Üzenet küldése a megadott telefonszámmal rendelkező partnernek	Üzenet küldése (új beszélgetés indítása, ha a megadott telefonszámnak nincs üzenetelőzménye).

A megadott azonosítóval rendelkező csoport törlése

Műveletazonosító:

DeleteGroup

Törli a megadott azonosítóval rendelkező csoportot. Ez akkor is sikeres lesz, ha vannak olyan partnerek, amelyek a csoport tagjai (a névjegyek nem törlődnek).

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.
A csoport azonosítója	group_id	True	integer	A törölni kívánt csoport numerikus azonosítója.

Válaszok

response

string

A megadott fizetés lemondása

Műveletazonosító:

CancelPayment

Megszakítja a megadott fizetést, és sms-ben jelzi a felhasználónak, hogy a kifizetést visszavonták. A kifizetések nem szerkeszthetők, ezért a kifizetés kijavításának legjobb módja a lemondás és az új fizetés kiállítása.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.
A fizetés azonosítója	payment_id	True	integer	A frissíteni kívánt fizetés numerikus azonosítója.

Válaszok

Name	Elérési út	Típus	Description
payment_id	payment_id	integer	A fizetés numerikus azonosítója.
request_date	request_date	string	Annak időbélyege, amikor a kifizetés kezdeti üzenete üzenetsorba lett küldve.
címzett	recipient	string	A fizetési címzett neve. Ez null értékű lehet, ha a partnernek nincs a telefonszámához társított neve.
leírás	description	string	A fizetés leírása. Ez nem jelenik meg a partner számára. Csak a belső felhasználók használják a kifizetések kontextusához.
customer_phone	customer_phone	string	A fizetést küldő partner telefonszáma.
amount_requested	amount_requested	float	A kifizetés által kért dollárban megadott összeg.
is_past_due	is_past_due	boolean	Azt jelzi, hogy a kifizetés túllépi-e a kérelem dátumát.
reminder_was_sent	reminder_was_sent	boolean	Azt jelzi, hogy már küldött-e szöveges emlékeztetőt erre a fizetésre.
transaction_status	transaction_status	string	A tranzakció állapota az authvia-ban. Ez az érték ismeretlenként kezdődik.
textrequest_payment_status	textrequest_payment_status	string	A tranzakció állapota a Szöveges kérelemben. Ez azt az állapotot jelöli, amely a Szövegkérelem alkalmazás fizetési oldalán jelenik meg. Elküldve kezdődik.
reference_number	reference_number	string	A fizetések létrehozásakor definiált, felhasználó által definiált azonosító, amely a fizetések gyors megkeresésére használható. A hivatkozási számok nem egyediek; számos kifizetésnek lehet ugyanaz a referenciája.

A megadott irányítópult törlése

Műveletazonosító:

DeleteDashboard

Törli a megadott irányítópultot.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.

Válaszok

response

string

A megadott szűrési feltételnek megfelelő összes partner lekérése

Műveletazonosító:

GetContacts

Lekéri a megadott szűrési feltételnek megfelelő összes névjegyet. A rendszer csak a megadott irányítópulton keres; nincs elérhető szám fiókszintű keresése.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Partner telefonszáma a kereséshez	contact_phone_number		string	Telefonszám, amely alapján szűrheti a névjegyeket.
"Last-message-time sent before" search timestamp in UTC time	last_message_timestamp_before_utc		date-time	Az utolsó elküldött vagy fogadott üzenet alapján a partnerek keresésének időtartama. Nem jelennek meg azok a névjegyek, akik ezután üzeneteket küldtek.
"Last-message-time sent after" search timestamp in UTC time	last_message_timestamp_after_utc		date-time	Az utolsó elküldött vagy fogadott üzenet alapján a partnerek keresésének időtartama. Nem jelennek meg azok a névjegyek, akiknek az utolsó elküldött üzenete ez előtt van.
"Létrehozás előtt" keresési időbélyeg	contact_created_before		date-time	A névjegyek létrehozásukkor történő keresésének időtartama. Ekkor nem jelennek meg a létrehozott névjegyek.
"Létrehozás után" keresési időbélyeg	contact_created_after		date-time	A névjegyek létrehozásukkor történő keresésének időtartama. Ekkor nem jelennek meg a korábban létrehozott névjegyek.
A partner beszélgetésének feloldása	is_resolved		boolean	Keresse meg azokat a partnereket, akiknek a beszélgetése megoldódott.
A partner letiltásának megállapítása	is_blocked		boolean	Keresse meg a letiltott partnereket.
A partner archiválása	is_archived		boolean	Az archivált partnerek keresése.
Azt jelzi, hogy a partner nincs-e letiltva	is_suppressed		boolean	A letiltott névjegyek keresése.
Azt jelzi, hogy a partner lemondta-e	has_opted_out		boolean	Keresse meg azokat a partnereket, akik nem fogadják az sms-eket.
"Last-message-time sent before" search timestamp	last_message_sent_before		date-time	A névjegyek keresésének időtartama az utolsó üzenet ügyfélnek való elküldésekor. Nem jelennek meg azok a névjegyek, akik ezután üzeneteket küldtek. Időbélyeget használ helyi időként. Ha időbélyeg alapján szeretne szűrni UTC idő szerint, használja a last_message_sent_before_utc
"Last-message-time sent after" search timestamp	last_message_sent_after		date-time	A névjegyek keresésének időtartama az utolsó üzenet ügyfélnek való elküldésekor. Nem jelennek meg azok a névjegyek, akiknek az utolsó elküldött üzenete ez előtt van. Időbélyeget használ helyi időként. Ha időbélyeg alapján szeretne szűrni UTC-idő szerint, használja a last_message_sent_after_utc
"Az utolsó üzenet időpontja korábban érkezett" keresési időbélyeg	last_message_received_before		date-time	Az ügyféltől kapott utolsó üzenet alapján a névjegyek keresésének leépítési ideje. Nem jelennek meg azok a névjegyek, akik ezt követően üzeneteket kaptak. Időbélyeget használ helyi időként. Ha időbélyeg alapján szeretne szűrni UTC idő szerint, használja a last_message_sent_before_utc
"Az utolsó üzenet időpontja a keresés időbélyege után érkezett"	last_message_received_after		date-time	Az ügyféltől kapott utolsó üzenet alapján a névjegyek keresésének leépítési ideje. Nem jelennek meg azok a névjegyek, akiknek az utolsó elküldött üzenete ez előtt van. Időbélyeget használ helyi időként. Ha időbélyeg alapján szeretne szűrni UTC idő szerint, használja a last_message_sent_before_utc
Névjegycímkék	tags		string	A névjegyek szűréséhez címkékre hivatkozó guidok vesszővel tagolt listája.
Partnercsoportok	groups		string	A csoportokra hivatkozó egész számazonosítók vesszővel tagolt listája, amelyek alapján szűrheti a partnereket.
A szűrni kívánt egyéni mező azonosítója	custom_field_id_1		string	Egyéni mezőre hivatkozó guid, amely alapján szűrheti a névjegyeket.
A szűrni kívánt egyéni mező értéke	custom_field_value_1		string	Az egyéni mezőre hivatkozó érték a partnerek szűréséhez.
A második egyéni mező azonosítója, amely alapján szűrni szeretne	custom_field_id_2		string	A névjegyek szűréséhez használt második egyéni mezőre hivatkozó guid.
A második egyéni mező értéke, amely alapján szűrni szeretne	custom_field_value_2		string	A névjegyek szűréséhez használt második egyéni mezőre hivatkozó érték.
A harmadik egyéni mező azonosítója, amely alapján szűrni szeretne	custom_field_id_3		string	Harmadik egyéni mezőre hivatkozó guid, amely alapján szűrheti a névjegyeket.
A szűrendő harmadik egyéni mező értéke	custom_field_value_3		string	A névjegyek szűréséhez harmadik egyéni mezőre hivatkozó érték.
Lekérendő számlap	page	True	integer	A lekérendő entitások lapja. Az értékek lekérésekor a page_size által definiált, oldalankénti maximális méret van megadva. Ha a lap nagyobb, mint az utolsó oldal, a rendszer egy üres tömböt ad vissza.
A laponként lekérendő entitások mennyisége	page_size	True	integer	Az egyes lapok mérete. Az értékek lekérésekor ez a maximális méret oldalanként, és az oldalparaméter által végzett további lapok elérése.
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.

Válaszok

Name	Elérési út	Típus	Description
oldal	meta.page	integer	Az entitások lapja. A lapon szereplő entitások mennyiségét a page_size határozza meg.
page_size	meta.page_size	integer	Az ezen a lapon kapott entitások száma.
total_items	meta.total_items	integer	Az adatbázisban elérhető entitások száma az oldal méretétől és számától függetlenül. A többi oldal megtekintéséhez módosítsa az oldalszámot a kérelemben.
items	items	array of object	A szöveges kérelemből kapott partnerentitások listája.
telefonszám	items.phone_number	string	A partner telefonszáma.
first_name	items.first_name	string	A partner utóneve.
last_name	items.last_name	string	A partner vezetékneve.
display_name	items.display_name	string	A partner teljes neve. Ez az alapértelmezett név jelenik meg a webalkalmazásban a névjegyek megtekintésekor.
is_suppressed	items.is_suppressed	boolean	Azt jelzi, hogy a partnerrel folytatott beszélgetés el van-e tiltva, és ezért nem kerül-e az üzenetsor tetejére, amikor megérkezik.
is_archived	items.is_archived	boolean	Azt, hogy a partnerrel folytatott beszélgetés archiválva van-e, és ezért nem látható-e a beszélgetések lekérdezésekor (alapértelmezés szerint).
is_blocked	items.is_blocked	boolean	Azt jelzi, hogy a partnerrel folytatott beszélgetés le van-e tiltva, ezért nem érkezik meg vagy nem tárolva.
suppressed_reason	items.suppressed_reason	string	A partner letiltásának okát leíró kifejezés. Ha is_suppressed hamis, akkor ez null értékű lesz.
jegyzet	items.note	string	A partnert leíró rövid kifejezés. Kényelmesen használható. Ez soha nem jelenik meg a partnernek.
groups	items.groups	array of integer	A partnerhez tartozó csoportokra hivatkozó egész számazonosítók tömbje.
contact_tags	items.contact_tags	array of string	A névjegyhez csatolt címkékre hivatkozó guidok tömbje.
custom_fields	items.custom_fields	array of object	A névjegyhez definiált egyéni mezőazonosítók és értékek tömbje.
azonosító	items.custom_fields.id	string	Egyéni mezőre hivatkozó guid.
value	items.custom_fields.value	string	A kapcsolattartó értéke ehhez az egyéni mezőhöz.
is_resolved	items.is_resolved	boolean	Azt jelzi, hogy a partnerrel folytatott beszélgetés megoldódott-e. A partner által fogadott új szövegek ezt a hamis értéket állítják be.
first_contact_utc	items.first_contact_utc	string	Az első üzenet címzettjének időbélyege.
opted_out_utc	items.opted_out_utc	string	Annak időbélyege, amikor a partner letiltotta az üzenetek fogadását.
last_msg_sent_utc	items.last_msg_sent_utc	string	Az utolsó üzenet címzettjének időbélyege.
last_msg_received_utc	items.last_msg_received_utc	string	Annak időbélyege, hogy mikor érkezett az utolsó üzenet a partnertől.
total_msgs_sent	items.total_msgs_sent	integer	A partnernek küldött összes üzenet száma.
total_msgs_received	items.total_msgs_received	integer	A partnertől kapott összes üzenet száma.
response_count	items.response_count	integer	A partnertől érkező válaszüzenetek teljes száma.
date_created_utc	items.date_created_utc	string	A ths-partner létrehozásának időbélyege.
last_contact_date_utc	items.last_contact_date_utc	string	Az utolsó üzenet küldésének vagy fogadásának időbélyege a partnertől.
message_id	items.last_message.message_id	string	Az üzenet azonosítója. Ez az érték minden üzenethez egyedi.
body	items.last_message.body	string	Az üzenet tartalma.
message_direction	items.last_message.message_direction	string	Szingular karakter, R vagy S, denoting, hogy ez az üzenet érkezett a partnertől, vagy küldött nekik, illetve.
response_by_username	items.last_message.response_by_username	string	Annak a szövegkérelem-felhasználónak a felhasználóneve, aki legutóbb üzenetet küldött ennek a felhasználónak.
message_timestamp_utc	items.last_message.message_timestamp_utc	string	Az üzenet elküldésének vagy fogadásának időbélyege.
delivery_status	items.last_message.delivery_status	string	Az üzenet aktuális állapota. Ez lehet "küldés", "kézbesítve", "hiba" vagy "küldés".
delivery_error	items.last_message.delivery_error	string	Hiba, amely miatt az üzenet nem érkezik meg. Ha a delivery_status nem "hiba", akkor ez az érték null értékű lesz.
mms_media	items.last_message.mms_media	array of string	Az üzenet mellékletére mutató URL-címek listája. Minden URL-cím szöveges kéréssel generált URL-cím lesz.

Adott irányítópult nevének frissítése

Műveletazonosító:

UpdateDashboardsName

Irányítópult frissítése. Ez nem módosítja az irányítópult telefonszámát. Ha új számot szeretne egy másik irányítópult névjegyeivel, létre kell hoznia egy új irányítópultot egy POST-tal, és tömeges exportálással/importálással kell hozzáadnia a névjegyeket.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.
Irányítópult neve	name		string	Az irányítópult új neve.

Válaszok

Name	Elérési út	Típus	Description
azonosító	id	integer	Az irányítópult numerikus azonosítója.
név	name	string	Az irányítópult neve.
phone	phone	string	Az irányítópulthoz társított szövegbeviteli szám.

Az összes egyéni mező lekérdezve

Műveletazonosító:

GetCustomFields

Lekéri az irányítópult összes egyéni mezőjét. Az egyéni mezők egyediek az irányítópultok között.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.

Válaszok

Name	Elérési út	Típus	Description
		array of object
azonosító	id	string	A mező numerikus azonosítója.
név	name	string	Az egyéni mező neve.

Az összes irányítópult lekérése egy fiókban

Műveletazonosító:

GetDashboards

Lekéri az összes irányítópultot egy fiókban.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Lekérendő számlap	page		integer	A lekérendő entitások lapja. Az értékek lekérésekor a page_size által definiált, oldalankénti maximális méret van megadva. Ha a lap nagyobb, mint az utolsó oldal, a rendszer egy üres tömböt ad vissza.
A laponként lekérendő entitások mennyisége	page_size		integer	Az egyes lapok mérete. Az értékek lekérésekor ez a maximális méret oldalanként, és az oldalparaméter által végzett további lapok elérése.

Válaszok

Name	Elérési út	Típus	Description
oldal	meta.page	integer	Az entitások lapja. A lapon szereplő entitások mennyiségét a page_size határozza meg.
page_size	meta.page_size	integer	Az ezen a lapon kapott entitások száma.
total_items	meta.total_items	integer	Az adatbázisban elérhető entitások száma az oldal méretétől és számától függetlenül. A többi oldal megtekintéséhez módosítsa az oldalszámot a kérelemben.
items	items	array of object	A Szöveges kérelemből kapott irányítópult-entitások listája.
azonosító	items.id	integer	Az irányítópult numerikus azonosítója.
név	items.name	string	Az irányítópult neve.
phone	items.phone	string	Az irányítópulthoz társított szövegbeviteli szám.

Beszélgetés archiválása

Műveletazonosító:

ArchiveConversation

Archiválja a beszélgetést, és eltávolítja az összes beszélgetés lekérési végpontjának eredményéből. A beszélgetések automatikusan archiválatlanok lesznek, ha az ügyfél szöveget küld a szöveges kérelem számára, vagy ha a szöveges kérelem számából küld egy szöveget az ügyfélnek. A beszélgetések archiválása jó módszer arra, hogy eltávolítsa a zsúfoltságokat azokról az ügyfelekről, akikhez a jövőben nem tervez beszélni. Vegye figyelembe, hogy ha egy ügyfél a "STOP" üzenetben szöveget ír, hogy megakadályozza, hogy további SMS-üzeneteket küldjön nekik, a beszélgetés automatikusan archiválva lesz.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.
Beszélgetés telefonszáma	phone_number	True	string	Az archiválni kívánt beszélgetés telefonszáma.

Válaszok

response

string

Beszélgetés archiválása

Műveletazonosító:

UnarchiveConversation

Egy beszélgetés archiválása. Ha egy beszélgetés archiválatlan, az ismét megjelenik az üzenetsorban. a /conversations végpont által visszaadott beszélgetésekben is megjelenik. Ha egy beszélgetés már nincs archiválva, ennek a módszernek nincs hatása.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.
Beszélgetés telefonszáma	phone_number	True	string	Az archiválni kívánt beszélgetés telefonszáma.

Válaszok

response

string

Beszélgetés üzenetének lekérése egy partner telefonszámával

Műveletazonosító:

GetMessagesByContactPhone

Kérje le a beszélgetést a megadott irányítópult és telefonszám között.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Lekérendő számlap	page	True	integer	A lekérendő entitások lapja. Az értékek lekérésekor a page_size által definiált, oldalankénti maximális méret van megadva. Ha a lap nagyobb, mint az utolsó oldal, a rendszer egy üres tömböt ad vissza.
A laponként lekérendő entitások mennyisége	page_size	True	integer	Az egyes lapok mérete. Az értékek lekérésekor ez a maximális méret oldalanként, és az oldalparaméter által végzett további lapok elérése.
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.
Partner telefonszáma a kereséshez	phone_number	True	string	A partner telefonszáma az üzenetek lekéréséhez.

Válaszok

Name	Elérési út	Típus	Description
oldal	meta.page	integer	Az entitások lapja. A lapon szereplő entitások mennyiségét a page_size határozza meg.
page_size	meta.page_size	integer	Az ezen a lapon kapott entitások száma.
total_items	meta.total_items	integer	Az adatbázisban elérhető entitások száma az oldal méretétől és számától függetlenül. A többi oldal megtekintéséhez módosítsa az oldalszámot a kérelemben.
items	items	array of object	A Szöveges kérelemből kapott üzenetentitások listája.
message_id	items.message_id	string	Az üzenet azonosítója. Ez az érték minden üzenethez egyedi.
body	items.body	string	Az üzenet tartalma.
message_direction	items.message_direction	string	Szingular karakter, R vagy S, denoting, hogy ez az üzenet érkezett a partnertől, vagy küldött nekik, illetve.
response_by_username	items.response_by_username	string	Annak a szövegkérelem-felhasználónak a felhasználóneve, aki legutóbb üzenetet küldött ennek a felhasználónak.
message_timestamp_utc	items.message_timestamp_utc	string	Az üzenet elküldésének vagy fogadásának időbélyege.
delivery_status	items.delivery_status	string	Az üzenet aktuális állapota. Ez lehet "küldés", "kézbesítve", "hiba" vagy "küldés".
delivery_error	items.delivery_error	string	Hiba, amely miatt az üzenet nem érkezik meg. Ha a delivery_status nem "hiba", akkor ez az érték null értékű lesz.
mms_media	items.mms_media	array of string	Az üzenet mellékletére mutató URL-címek listája. Minden URL-cím szöveges kéréssel generált URL-cím lesz.

Csoport frissítése a megadott azonosítóval

Műveletazonosító:

UpdateGroup

A csoport nevének frissítése a csoport numerikus azonosítójával. Ha a megadott csoportazonosító nem létezik, a hívás sikertelen lesz.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.
A csoport azonosítója	group_id	True	integer	A frissíteni kívánt csoport numerikus azonosítója.
Csoport neve	name		string	A csoport új neve.
Csoportosítási megjegyzés	notes		string	A csoportot leíró rövid kifejezés. Kényelmesen használható.

Válaszok

Name	Elérési út	Típus	Description
azonosító	id	integer	A csoport numerikus azonosítója.
group_member_count	group_member_count	integer	A csoport tagjainak száma.
is_keyword	is_keyword	boolean	Ez a csoport egy kulcsszócsoport. Az ilyen csoportok automatikusan létrejönnek, amikor egy felhasználó beállít egy kulcsszót. A rendszer a regisztrációkor automatikusan felveszi a névjegyeket.
név	name	string	A csoport neve.
jegyzetek	notes	string	A csoport bármely megjegyzése.
last_message_sent_utc	last_message_sent_utc	string	A csoport utolsó üzenetének elküldésének időbélyege.

Csoport lekérése az azonosító alapján

Műveletazonosító:

GetGroupById

Lekéri a csoportot a megadott azonosítóval.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.
A csoport azonosítója	group_id	True	integer	A lekérni kívánt csoport numerikus azonosítója.

Válaszok

Name	Elérési út	Típus	Description
azonosító	id	integer	A csoport numerikus azonosítója.
group_member_count	group_member_count	integer	A csoport tagjainak száma.
is_keyword	is_keyword	boolean	Ez a csoport egy kulcsszócsoport. Az ilyen csoportok automatikusan létrejönnek, amikor egy felhasználó beállít egy kulcsszót. A rendszer a regisztrációkor automatikusan felveszi a névjegyeket.
név	name	string	A csoport neve.
jegyzetek	notes	string	A csoport bármely megjegyzése.
last_message_sent_utc	last_message_sent_utc	string	A csoport utolsó üzenetének elküldésének időbélyege.

Fizetés megjelölése fizetősként

Műveletazonosító:

MarkPaymentPaid

A fizetést "fizetősként" zárja be. Használja ezt a végpontot arra az esetre, ha a fizetés a fizetési kérelem portáltól eltérő módon történik. Ezzel bezárja a kifizetést, és hozzáadja annak összegét a statisztikákhoz. Ez a végpont nem szükséges a szöveges kérelemen keresztül küldött fizetési portálon keresztül fizetett kifizetésekhez; amely automatikusan megjelöli a kifizetést fizetősként.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.
A fizetés azonosítója	payment_id	True	integer	A frissíteni kívánt fizetés numerikus azonosítója.

Válaszok

Name	Elérési út	Típus	Description
payment_id	payment_id	integer	A fizetés numerikus azonosítója.
request_date	request_date	string	Annak időbélyege, amikor a kifizetés kezdeti üzenete üzenetsorba lett küldve.
címzett	recipient	string	A fizetési címzett neve. Ez null értékű lehet, ha a partnernek nincs a telefonszámához társított neve.
leírás	description	string	A fizetés leírása. Ez nem jelenik meg a partner számára. Csak a belső felhasználók használják a kifizetések kontextusához.
customer_phone	customer_phone	string	A fizetést küldő partner telefonszáma.
amount_requested	amount_requested	float	A kifizetés által kért dollárban megadott összeg.
is_past_due	is_past_due	boolean	Azt jelzi, hogy a kifizetés túllépi-e a kérelem dátumát.
reminder_was_sent	reminder_was_sent	boolean	Azt jelzi, hogy már küldött-e szöveges emlékeztetőt erre a fizetésre.
transaction_status	transaction_status	string	A tranzakció állapota az authvia-ban. Ez az érték ismeretlenként kezdődik.
textrequest_payment_status	textrequest_payment_status	string	A tranzakció állapota a Szöveges kérelemben. Ez azt az állapotot jelöli, amely a Szövegkérelem alkalmazás fizetési oldalán jelenik meg. Elküldve kezdődik.
reference_number	reference_number	string	A fizetések létrehozásakor definiált, felhasználó által definiált azonosító, amely a fizetések gyors megkeresésére használható. A hivatkozási számok nem egyediek; számos kifizetésnek lehet ugyanaz a referenciája.

Információk lekérése erről az adott irányítópultról

Műveletazonosító:

GetDashboard

Az irányítópult nevét és telefonját adja vissza.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.

Válaszok

Name	Elérési út	Típus	Description
azonosító	id	integer	Az irányítópult numerikus azonosítója.
név	name	string	Az irányítópult neve.
phone	phone	string	Az irányítópulthoz társított szövegbeviteli szám.

Küldjön egy követő szöveget, amely emlékezteti a felhasználót a megadott fizetés kifizetésére

Műveletazonosító:

SendPaymentReminder

Emlékeztetőt küld a partnernek a megadott fizetés kifizetéséhez. Az üzenet tartalma automatikusan létre lesz hozva. A levélszemét elkerülése érdekében fizetésenként csak egy emlékeztető küldhető

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.
A fizetés azonosítója	payment_id	True	integer	A frissíteni kívánt fizetés numerikus azonosítója.

Válaszok

Name	Elérési út	Típus	Description
payment_id	payment_id	integer	A fizetés numerikus azonosítója.
request_date	request_date	string	Annak időbélyege, amikor a kifizetés kezdeti üzenete üzenetsorba lett küldve.
címzett	recipient	string	A fizetési címzett neve. Ez null értékű lehet, ha a partnernek nincs a telefonszámához társított neve.
leírás	description	string	A fizetés leírása. Ez nem jelenik meg a partner számára. Csak a belső felhasználók használják a kifizetések kontextusához.
customer_phone	customer_phone	string	A fizetést küldő partner telefonszáma.
amount_requested	amount_requested	float	A kifizetés által kért dollárban megadott összeg.
is_past_due	is_past_due	boolean	Azt jelzi, hogy a kifizetés túllépi-e a kérelem dátumát.
reminder_was_sent	reminder_was_sent	boolean	Azt jelzi, hogy már küldött-e szöveges emlékeztetőt erre a fizetésre.
transaction_status	transaction_status	string	A tranzakció állapota az authvia-ban. Ez az érték ismeretlenként kezdődik.
textrequest_payment_status	textrequest_payment_status	string	A tranzakció állapota a Szöveges kérelemben. Ez azt az állapotot jelöli, amely a Szövegkérelem alkalmazás fizetési oldalán jelenik meg. Elküldve kezdődik.
reference_number	reference_number	string	A fizetések létrehozásakor definiált, felhasználó által definiált azonosító, amely a fizetések gyors megkeresésére használható. A hivatkozási számok nem egyediek; számos kifizetésnek lehet ugyanaz a referenciája.

Lekéri a fizetést a megadott azonosítóval

Műveletazonosító:

GetPayment

Lekéri a fizetést a megadott azonosítóval.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.
A fizetés azonosítója	payment_id	True	integer	A lekérni kívánt fizetés numerikus azonosítója.

Válaszok

Name	Elérési út	Típus	Description
payment_id	payment_id	integer	A fizetés numerikus azonosítója.
request_date	request_date	string	Annak időbélyege, amikor a kifizetés kezdeti üzenete üzenetsorba lett küldve.
címzett	recipient	string	A fizetési címzett neve. Ez null értékű lehet, ha a partnernek nincs a telefonszámához társított neve.
leírás	description	string	A fizetés leírása. Ez nem jelenik meg a partner számára. Csak a belső felhasználók használják a kifizetések kontextusához.
customer_phone	customer_phone	string	A fizetést küldő partner telefonszáma.
amount_requested	amount_requested	float	A kifizetés által kért dollárban megadott összeg.
is_past_due	is_past_due	boolean	Azt jelzi, hogy a kifizetés túllépi-e a kérelem dátumát.
reminder_was_sent	reminder_was_sent	boolean	Azt jelzi, hogy már küldött-e szöveges emlékeztetőt erre a fizetésre.
transaction_status	transaction_status	string	A tranzakció állapota az authvia-ban. Ez az érték ismeretlenként kezdődik.
textrequest_payment_status	textrequest_payment_status	string	A tranzakció állapota a Szöveges kérelemben. Ez azt az állapotot jelöli, amely a Szövegkérelem alkalmazás fizetési oldalán jelenik meg. Elküldve kezdődik.
reference_number	reference_number	string	A fizetések létrehozásakor definiált, felhasználó által definiált azonosító, amely a fizetések gyors megkeresésére használható. A hivatkozási számok nem egyediek; számos kifizetésnek lehet ugyanaz a referenciája.

Lekéri a megadott telefonszámmal rendelkező partnert

Műveletazonosító:

GetContactByPhoneNumber

Lekéri a megadott telefonszámmal rendelkező partnert

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.
A partner telefonszáma	phone_number	True	string	A lekérendő partner telefonszáma.

Válaszok

Name	Elérési út	Típus	Description
telefonszám	phone_number	string	A partner telefonszáma.
first_name	first_name	string	A partner utóneve.
last_name	last_name	string	A partner vezetékneve.
display_name	display_name	string	A partner teljes neve. Ez az alapértelmezett név jelenik meg a webalkalmazásban a névjegyek megtekintésekor.
is_suppressed	is_suppressed	boolean	Azt jelzi, hogy a partnerrel folytatott beszélgetés el van-e tiltva, és ezért nem kerül-e az üzenetsor tetejére, amikor megérkezik.
is_archived	is_archived	boolean	Azt, hogy a partnerrel folytatott beszélgetés archiválva van-e, és ezért nem látható-e a beszélgetések lekérdezésekor (alapértelmezés szerint).
is_blocked	is_blocked	boolean	Azt jelzi, hogy a partnerrel folytatott beszélgetés le van-e tiltva, ezért nem érkezik meg vagy nem tárolva.
suppressed_reason	suppressed_reason	string	A partner letiltásának okát leíró kifejezés. Ha is_suppressed hamis, akkor ez null értékű lesz.
jegyzet	note	string	A partnert leíró rövid kifejezés. Kényelmesen használható. Ez soha nem jelenik meg a partnernek.
groups	groups	array of integer	A partnerhez tartozó csoportokra hivatkozó egész számazonosítók tömbje.
contact_tags	contact_tags	array of string	A névjegyhez csatolt címkékre hivatkozó guidok tömbje.
custom_fields	custom_fields	array of object	A névjegyhez definiált egyéni mezőazonosítók és értékek tömbje.
azonosító	custom_fields.id	string	Egyéni mezőre hivatkozó guid.
value	custom_fields.value	string	A kapcsolattartó értéke ehhez az egyéni mezőhöz.
is_resolved	is_resolved	boolean	Azt jelzi, hogy a partnerrel folytatott beszélgetés megoldódott-e. A partner által fogadott új szövegek ezt a hamis értéket állítják be.
first_contact_utc	first_contact_utc	string	Az első üzenet címzettjének időbélyege.
opted_out_utc	opted_out_utc	string	Annak időbélyege, amikor a partner letiltotta az üzenetek fogadását.
last_msg_sent_utc	last_msg_sent_utc	string	Az utolsó üzenet címzettjének időbélyege.
last_msg_received_utc	last_msg_received_utc	string	Annak időbélyege, hogy mikor érkezett az utolsó üzenet a partnertől.
total_msgs_sent	total_msgs_sent	integer	A partnernek küldött összes üzenet száma.
total_msgs_received	total_msgs_received	integer	A partnertől kapott összes üzenet száma.
response_count	response_count	integer	A partnertől érkező válaszüzenetek teljes száma.
date_created_utc	date_created_utc	string	A ths-partner létrehozásának időbélyege.
last_contact_date_utc	last_contact_date_utc	string	Az az időbélyeg, amikor az utolsó üzenetet elküldték vagy megkapták a partnertől.
message_id	last_message.message_id	string	Az üzenet azonosítója. Ez az érték minden üzenethez egyedi.
body	last_message.body	string	Az üzenet tartalma.
message_direction	last_message.message_direction	string	Szingular karakter, R vagy S, denoting, hogy ez az üzenet érkezett a partnertől, vagy küldött nekik, illetve.
response_by_username	last_message.response_by_username	string	Annak a szövegkérelem-felhasználónak a felhasználóneve, aki legutóbb üzenetet küldött ennek a felhasználónak.
message_timestamp_utc	last_message.message_timestamp_utc	string	Az üzenet elküldésének vagy fogadásának időbélyege.
delivery_status	last_message.delivery_status	string	Az üzenet aktuális állapota. Ez lehet "küldés", "kézbesítve", "hiba" vagy "küldés".
delivery_error	last_message.delivery_error	string	Hiba, amely miatt az üzenet nem érkezik meg. Ha a delivery_status nem "hiba", akkor ez az érték null értékű lesz.
mms_media	last_message.mms_media	array of string	Az üzenet mellékletére mutató URL-címek listája. Minden URL-cím szöveges kéréssel generált URL-cím lesz.

Lekéri az irányítópult összes beszélgetését

Műveletazonosító:

GetConversations

Lekéri az irányítópult összes beszélgetését, és tartalmazza az egyes beszélgetések utolsó üzenetének adatait.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Névjegycímkék	tags		string	A beszélgetések szűréséhez címkékre hivatkozó guidok vesszővel tagolt listája.
Csak a megoldott beszélgetések megjelenítése	show_unresolved_only		string	Azt határozza meg, hogy csak olyan partnerekre keressen-e rá, akiknek a beszélgetései megoldva lettek. Ha ez hamis, akkor a feloldott és a megoldatlan beszélgetések is megjelennek.
Archivált beszélgetések belefoglalása	include_archived		string	Az archivált partnerekkel folytatott beszélgetések belefoglalása.
Telefonszámok és partnernév alapján szűrendő kifejezés	search		string	Keresési kifejezés a beszélgetések telefonszám vagy megjelenítendő név szerinti szűréséhez. Ha a keresési kifejezés kisebb, mint egy teljes név vagy telefonszám, a keresés az összes olyan beszélgetést visszaadja, amely részben megfelel a kifejezésnek.
Lekérendő számlap	page		integer	A lekérendő entitások lapja. Az értékek lekérésekor a page_size által definiált, oldalankénti maximális méret van megadva. Ha a lap nagyobb, mint az utolsó oldal, a rendszer egy üres tömböt ad vissza.
A laponként lekérendő entitások mennyisége	page_size		integer	Az egyes lapok mérete. Az értékek lekérésekor ez a maximális méret oldalanként, és az oldalparaméter által végzett további lapok elérése.
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.

Válaszok

Name	Elérési út	Típus	Description
oldal	meta.page	integer	Az entitások lapja. A lapon szereplő entitások mennyiségét a page_size határozza meg.
page_size	meta.page_size	integer	Az ezen a lapon kapott entitások száma.
total_items	meta.total_items	integer	Az adatbázisban elérhető entitások száma az oldal méretétől és számától függetlenül. A többi oldal megtekintéséhez módosítsa az oldalszámot a kérelemben.
items	items	array of object	A Szöveges kérelemből kapott beszélgetési entitások listája.
telefonszám	items.phone_number	string	A partner telefonszáma.
message_id	items.last_message.message_id	string	Az üzenet azonosítója. Ez az érték minden üzenethez egyedi.
body	items.last_message.body	string	Az üzenet tartalma.
message_direction	items.last_message.message_direction	string	Szingular karakter, R vagy S, denoting, hogy ez az üzenet érkezett a partnertől, vagy küldött nekik, illetve.
response_by_username	items.last_message.response_by_username	string	Annak a szövegkérelem-felhasználónak a felhasználóneve, aki legutóbb üzenetet küldött ennek a felhasználónak.
message_timestamp_utc	items.last_message.message_timestamp_utc	string	Az üzenet elküldésének vagy fogadásának időbélyege.
delivery_status	items.last_message.delivery_status	string	Az üzenet aktuális állapota. Ez lehet "küldés", "kézbesítve", "hiba" vagy "küldés".
delivery_error	items.last_message.delivery_error	string	Hiba, amely miatt az üzenet nem érkezik meg. Ha a delivery_status nem "hiba", akkor ez az érték null értékű lesz.
mms_media	items.last_message.mms_media	array of string	Az üzenet mellékletére mutató URL-címek listája. Minden URL-cím szöveges kéréssel generált URL-cím lesz.

Lekéri az összes csoportot

Műveletazonosító:

GetGroups

Lekéri a felhasználó fiókjához tartozó összes csoportot.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Lekérendő számlap	page	True	integer	A lekérendő entitások lapja. Az értékek lekérésekor a page_size által definiált, oldalankénti maximális méret van megadva. Ha a lap nagyobb, mint az utolsó oldal, a rendszer egy üres tömböt ad vissza.
A laponként lekérendő entitások mennyisége	page_size	True	integer	Az egyes lapok mérete. Az értékek lekérésekor ez a maximális méret oldalanként, és az oldalparaméter által végzett további lapok elérése.
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.

Válaszok

Name	Elérési út	Típus	Description
oldal	meta.page	integer	Az entitások lapja. A lapon szereplő entitások mennyiségét a page_size határozza meg.
page_size	meta.page_size	integer	Az ezen a lapon kapott entitások száma.
total_items	meta.total_items	integer	Az adatbázisban elérhető entitások száma az oldal méretétől és számától függetlenül. A többi oldal megtekintéséhez módosítsa az oldalszámot a kérelemben.
items	items	array of object	A szöveges kérelemből kapott csoportentitások listája.
azonosító	items.id	integer	A csoport numerikus azonosítója.
group_member_count	items.group_member_count	integer	A csoport tagjainak száma.
is_keyword	items.is_keyword	boolean	Ez a csoport egy kulcsszócsoport. Az ilyen csoportok automatikusan létrejönnek, amikor egy felhasználó beállít egy kulcsszót. A rendszer a regisztrációkor automatikusan felveszi a névjegyeket.
név	items.name	string	A csoport neve.
jegyzetek	items.notes	string	A csoport bármely megjegyzése.
last_message_sent_utc	items.last_message_sent_utc	string	Annak az időbélyegnek a száma, amikor az utolsó csoportüzenetet küldték ehhez a csoporthoz.

Lekéri az összes címkét

Műveletazonosító:

GetTags

Lekéri az irányítópult összes címkét. A címkék egyediek az irányítópultok között.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.
Lekérendő számlap	page	True	integer	A lekérendő entitások lapja. Az értékek lekérésekor a page_size által definiált, oldalankénti maximális méret van megadva. Ha a lap nagyobb, mint az utolsó oldal, a rendszer egy üres tömböt ad vissza.
A laponként lekérendő entitások mennyisége	page_size	True	integer	Az egyes lapok mérete. Az értékek lekérésekor ez a maximális méret oldalanként, és az oldalparaméter által végzett további lapok elérése.

Válaszok

Name	Elérési út	Típus	Description
oldal	meta.page	integer	Az entitások lapja. A lapon szereplő entitások mennyiségét a page_size határozza meg.
page_size	meta.page_size	integer	Az ezen a lapon kapott entitások száma.
total_items	meta.total_items	integer	Az adatbázisban elérhető entitások száma az oldal méretétől és számától függetlenül. A többi oldal megtekintéséhez módosítsa az oldalszámot a kérelemben.
items	items	array of object	A Szöveges kérelemből kapott címkeentitások listája.
azonosító	items.id	string	A címke numerikus azonosítója.
tag_color	items.tag_color	string	A címke színe. Ennek érvényes hexadecimális színkódnak kell lennie.
címke	items.tag	string	A címke neve.

Lekéri az összes kifizetést

Műveletazonosító:

GetPayments

Lekéri az összes kifizetést, beleértve a lemondott és a fizetős kifizetéseket is. Ezek a lekérdezési paraméterekkel szűrhetők.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
A fizetés referenciasztringje	reference_number		string	A fizetések létrehozásakor definiált felhasználó által definiált azonosító, amely a fizetések gyors megkeresésére használható. A hivatkozási számok nem egyediek; számos kifizetésnek lehet ugyanaz a referenciája.
Fizetési telefonszám	phone_number		string	Annak a partnernek a telefonszáma, akinek a fizetést küldték.
Rendezés szempontja	sort_type		string	A kifizetések rendezéséhez kapcsolódó tulajdonság. Lehet "amount", "contact", "date", "status".
Rendezés iránya	sort_direction		string	A kifizetések rendezésének iránya. Lehet "desc" a legnagyobbtól a legkisebbig, vagy "asc" a legkisebb és a legnagyobb.
Lekérendő számlap	page	True	integer	A lekérendő entitások lapja. Az értékek lekérésekor a page_size által definiált, oldalankénti maximális méret van megadva. Ha a lap nagyobb, mint az utolsó oldal, a rendszer egy üres tömböt ad vissza.
A laponként lekérendő entitások mennyisége	page_size	True	integer	Az egyes lapok mérete. Az értékek lekérésekor ez a maximális méret oldalanként, és az oldalparaméter által végzett további lapok elérése.
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.

Válaszok

Name	Elérési út	Típus	Description
oldal	meta.page	integer	Az entitások lapja. A lapon szereplő entitások mennyiségét a page_size határozza meg.
page_size	meta.page_size	integer	Az ezen a lapon kapott entitások száma.
total_items	meta.total_items	integer	Az adatbázisban elérhető entitások száma az oldal méretétől és számától függetlenül. A többi oldal megtekintéséhez módosítsa az oldalszámot a kérelemben.
items	items	array of object	A szöveges kérelemből kapott fizetési entitások listája.
payment_id	items.payment_id	integer	A fizetés numerikus azonosítója.
request_date	items.request_date	string	Annak időbélyege, amikor a kifizetés kezdeti üzenete üzenetsorba lett küldve.
címzett	items.recipient	string	A fizetési címzett neve. Ez null értékű lehet, ha a partnernek nincs a telefonszámához társított neve.
leírás	items.description	string	A fizetés leírása. Ez nem jelenik meg a partner számára. Csak a belső felhasználók használják a kifizetések kontextusához.
customer_phone	items.customer_phone	string	A fizetést küldő partner telefonszáma.
amount_requested	items.amount_requested	float	A kifizetés által kért dollárban megadott összeg.
is_past_due	items.is_past_due	boolean	Azt jelzi, hogy a kifizetés túllépi-e a kérelem dátumát.
reminder_was_sent	items.reminder_was_sent	boolean	Azt jelzi, hogy már küldött-e szöveges emlékeztetőt erre a fizetésre.
transaction_status	items.transaction_status	string	A tranzakció állapota az authvia-ban. Ez az érték ismeretlenként kezdődik.
textrequest_payment_status	items.textrequest_payment_status	string	A tranzakció állapota a Szöveges kérelemben. Ez azt az állapotot jelöli, amely a Szövegkérelem alkalmazás fizetési oldalán jelenik meg. Elküldve kezdődik.
reference_number	items.reference_number	string	A fizetések létrehozásakor definiált, felhasználó által definiált azonosító, amely a fizetések gyors megkeresésére használható. A hivatkozási számok nem egyediek; számos kifizetésnek lehet ugyanaz a referenciája.

Névjegy létrehozása vagy frissítése

Műveletazonosító:

CreateContact

Létrehoz vagy frissít egy partnert (attól függően, hogy már létezik-e a megadott telefonszámmal).

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.
Kapcsolattartó telefonszáma	phone_number	True	string	A létrehozni vagy frissíteni kívánt partner telefonszáma.
Kapcsolattartó utóneve	first_name		string	A partner új utóneve.
Kapcsolattartó vezetékneve	last_name		string	A partner új vezetékneve.
A partner teljes neve	display_name		string	A partner új teljes neve. Ez az alapértelmezett név jelenik meg a webalkalmazásban a névjegyek megtekintésekor.
Letiltja-e a partnertől érkező üzeneteket?	is_suppressed		boolean	Meghatározza, hogy az ezzel a partnerrel folytatott beszélgetések le vannak-e tiltva, és ezért nem kerülnek-e le az üzenetsor tetejére fogadáskor.
A partner üzenetei archiválva vannak-e	is_archived		boolean	Meghatározza, hogy a partnerrel folytatott beszélgetések archiválva vannak-e, ezért nem láthatók a beszélgetések lekérdezésekor (alapértelmezés szerint).
Azt jelzi, hogy a partnertől érkező üzenetek le vannak-e tiltva	is_blocked		boolean	Meghatározza, hogy az ezzel a partnerrel folytatott beszélgetések le vannak-e tiltva, ezért nem fogadják vagy tárolják őket.
A partner letiltásának oka	suppressed_reason		string	A partner letiltásának okát leíró kifejezés.
Névjegyjegyzet	note		string	A partnert leíró rövid kifejezés. Kényelmesen használható. Ez soha nem jelenik meg a partnernek.
Partnercsoportok	groups		array of integer	A partnerhez tartozó csoportokra hivatkozó egész számazonosítók tömbje.
Névjegycímkék	contact_tags		array of string	A névjegyhez csatolt címkékre hivatkozó guidok tömbje.
Egyéni mezőazonosító	id		string	Egyéni mezőre hivatkozó guid.
Egyéni mező értéke	value		string	A kapcsolattartó értéke ehhez az egyéni mezőhöz.
A partnerrel folytatott aktuális beszélgetés feloldása	is_resolved		boolean	Meghatározza, hogy a partnerrel folytatott aktuális beszélgetés feloldva van-e. A partner által fogadott új szövegek ezt a hamis értéket állítják be.

Válaszok

Name	Elérési út	Típus	Description
telefonszám	phone_number	string	A partner telefonszáma.
first_name	first_name	string	A partner utóneve.
last_name	last_name	string	A partner vezetékneve.
display_name	display_name	string	A partner teljes neve. Ez az alapértelmezett név jelenik meg a webalkalmazásban a névjegyek megtekintésekor.
is_suppressed	is_suppressed	boolean	Azt jelzi, hogy a partnerrel folytatott beszélgetés el van-e tiltva, és ezért nem kerül-e az üzenetsor tetejére, amikor megérkezik.
is_archived	is_archived	boolean	Azt, hogy a partnerrel folytatott beszélgetés archiválva van-e, és ezért nem látható-e a beszélgetések lekérdezésekor (alapértelmezés szerint).
is_blocked	is_blocked	boolean	Azt jelzi, hogy a partnerrel folytatott beszélgetés le van-e tiltva, ezért nem érkezik meg vagy nem tárolva.
suppressed_reason	suppressed_reason	string	A partner letiltásának okát leíró kifejezés. Ha is_suppressed hamis, akkor ez null értékű lesz.
jegyzet	note	string	A partnert leíró rövid kifejezés. Kényelmesen használható. Ez soha nem jelenik meg a partnernek.
groups	groups	array of integer	A partnerhez tartozó csoportokra hivatkozó egész számazonosítók tömbje.
contact_tags	contact_tags	array of string	A névjegyhez csatolt címkékre hivatkozó guidok tömbje.
custom_fields	custom_fields	array of object	A névjegyhez definiált egyéni mezőazonosítók és értékek tömbje.
azonosító	custom_fields.id	string	Egyéni mezőre hivatkozó guid.
value	custom_fields.value	string	A kapcsolattartó értéke ehhez az egyéni mezőhöz.
is_resolved	is_resolved	boolean	Azt jelzi, hogy a partnerrel folytatott beszélgetés megoldódott-e. A partner által fogadott új szövegek ezt a hamis értéket állítják be.
first_contact_utc	first_contact_utc	string	Az első üzenet címzettjének időbélyege.
opted_out_utc	opted_out_utc	string	Annak időbélyege, amikor a partner letiltotta az üzenetek fogadását.
last_msg_sent_utc	last_msg_sent_utc	string	Az utolsó üzenet címzettjének időbélyege.
last_msg_received_utc	last_msg_received_utc	string	Annak időbélyege, hogy mikor érkezett az utolsó üzenet a partnertől.
total_msgs_sent	total_msgs_sent	integer	A partnernek küldött összes üzenet száma.
total_msgs_received	total_msgs_received	integer	A partnertől kapott összes üzenet száma.
response_count	response_count	integer	A partnertől érkező válaszüzenetek teljes száma.
date_created_utc	date_created_utc	string	A ths-partner létrehozásának időbélyege.
last_contact_date_utc	last_contact_date_utc	string	Az utolsó üzenet küldésének vagy fogadásának időbélyege a partnertől.
message_id	last_message.message_id	string	Az üzenet azonosítója. Ez az érték minden üzenethez egyedi.
body	last_message.body	string	Az üzenet tartalma.
message_direction	last_message.message_direction	string	Szingular karakter, R vagy S, denoting, hogy ez az üzenet érkezett a partnertől, vagy küldött nekik, illetve.
response_by_username	last_message.response_by_username	string	Annak a szövegkérelem-felhasználónak a felhasználóneve, aki legutóbb üzenetet küldött ennek a felhasználónak.
message_timestamp_utc	last_message.message_timestamp_utc	string	Az üzenet elküldésének vagy fogadásának időbélyege.
delivery_status	last_message.delivery_status	string	Az üzenet aktuális állapota. Ez lehet "küldés", "kézbesítve", "hiba" vagy "küldés".
delivery_error	last_message.delivery_error	string	Hiba, amely miatt az üzenet nem érkezik meg. Ha a delivery_status nem "hiba", akkor ez az érték null értékű lesz.
mms_media	last_message.mms_media	array of string	Az üzenet mellékletére mutató URL-címek listája. Minden URL-cím szöveges kéréssel generált URL-cím lesz.

Névjegyek tömeges frissítése

Műveletazonosító:

BulkUpdateContacts

Csak a megadott irányítópulton lesznek hozzáadva névjegyek; a partnerek irányítópultok szerint vannak rendszerezve, és nincs elérhető szám fiókszintű keresése.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.
Kapcsolattartó telefonszáma	phone_number		string	A létrehozni vagy frissíteni kívánt partner telefonszáma.
Kapcsolattartó utóneve	first_name		string	A partner új utóneve.
Kapcsolattartó vezetékneve	last_name		string	A partner új vezetékneve.
A partner teljes neve	display_name		string	A partner új teljes neve. Ez az alapértelmezett név jelenik meg a webalkalmazásban a névjegyek megtekintésekor.
Letiltja-e a partnertől érkező üzeneteket?	is_suppressed		boolean	Meghatározza, hogy az ezzel a partnerrel folytatott beszélgetések le vannak-e tiltva, és ezért nem kerülnek-e le az üzenetsor tetejére fogadáskor.
A partner üzenetei archiválva vannak-e	is_archived		boolean	Meghatározza, hogy a partnerrel folytatott beszélgetések archiválva vannak-e, ezért nem láthatók a beszélgetések lekérdezésekor (alapértelmezés szerint).
Azt jelzi, hogy a partnertől érkező üzenetek le vannak-e tiltva	is_blocked		boolean	Meghatározza, hogy az ezzel a partnerrel folytatott beszélgetések le vannak-e tiltva, ezért nem fogadják vagy tárolják őket.
A partner letiltásának oka	suppressed_reason		string	A partner letiltásának okát leíró kifejezés.
Névjegyjegyzet	note		string	A partnert leíró rövid kifejezés. Kényelmesen használható. Ez soha nem jelenik meg a partnernek.
Partnercsoportok	groups		array of integer	A partnerhez tartozó csoportokra hivatkozó egész számazonosítók tömbje.
Névjegycímkék	contact_tags		array of string	A névjegyhez csatolt címkékre hivatkozó guidok tömbje.
Egyéni mezőazonosító	id		string	Egyéni mezőre hivatkozó guid.
Egyéni mező értéke	value		string	A kapcsolattartó értéke ehhez az egyéni mezőhöz.
A partnerrel folytatott aktuális beszélgetés feloldása	is_resolved		boolean	Meghatározza, hogy a partnerrel folytatott aktuális beszélgetés feloldva van-e. A partner által fogadott új szövegek ezt a hamis értéket állítják be.

Válaszok

Name	Elérési út	Típus	Description
		array of object
telefonszám	phone_number	string	A partner telefonszáma.
first_name	first_name	string	A partner utóneve.
last_name	last_name	string	A partner vezetékneve.
display_name	display_name	string	A partner teljes neve. Ez az alapértelmezett név jelenik meg a webalkalmazásban a névjegyek megtekintésekor.
is_suppressed	is_suppressed	boolean	Azt jelzi, hogy a partnerrel folytatott beszélgetés el van-e tiltva, és ezért nem kerül-e az üzenetsor tetejére, amikor megérkezik.
is_archived	is_archived	boolean	Azt, hogy a partnerrel folytatott beszélgetés archiválva van-e, és ezért nem látható-e a beszélgetések lekérdezésekor (alapértelmezés szerint).
is_blocked	is_blocked	boolean	Azt jelzi, hogy a partnerrel folytatott beszélgetés le van-e tiltva, ezért nem érkezik meg vagy nem tárolva.
suppressed_reason	suppressed_reason	string	A partner letiltásának okát leíró kifejezés. Ha is_suppressed hamis, akkor ez null értékű lesz.
jegyzet	note	string	A partnert leíró rövid kifejezés. Kényelmesen használható. Ez soha nem jelenik meg a partnernek.
groups	groups	array of integer	A partnerhez tartozó csoportokra hivatkozó egész számazonosítók tömbje.
contact_tags	contact_tags	array of string	A névjegyhez csatolt címkékre hivatkozó guidok tömbje.
custom_fields	custom_fields	array of object	A névjegyhez definiált egyéni mezőazonosítók és értékek tömbje.
azonosító	custom_fields.id	string	Egyéni mezőre hivatkozó guid.
value	custom_fields.value	string	A kapcsolattartó értéke ehhez az egyéni mezőhöz.
is_resolved	is_resolved	boolean	Azt jelzi, hogy a partnerrel folytatott beszélgetés megoldódott-e. A partner által fogadott új szövegek ezt a hamis értéket állítják be.
first_contact_utc	first_contact_utc	string	Az első üzenet címzettjének időbélyege.
opted_out_utc	opted_out_utc	string	Annak időbélyege, amikor a partner letiltotta az üzenetek fogadását.
last_msg_sent_utc	last_msg_sent_utc	string	Az utolsó üzenet címzettjének időbélyege.
last_msg_received_utc	last_msg_received_utc	string	Annak időbélyege, hogy mikor érkezett az utolsó üzenet a partnertől.
total_msgs_sent	total_msgs_sent	integer	A partnernek küldött összes üzenet száma.
total_msgs_received	total_msgs_received	integer	A partnertől kapott összes üzenet száma.
response_count	response_count	integer	A partnertől érkező válaszüzenetek teljes száma.
date_created_utc	date_created_utc	string	A ths-partner létrehozásának időbélyege.
last_contact_date_utc	last_contact_date_utc	string	Az utolsó üzenet küldésének vagy fogadásának időbélyege a partnertől.
message_id	last_message.message_id	string	Az üzenet azonosítója. Ez az érték minden üzenethez egyedi.
body	last_message.body	string	Az üzenet tartalma.
message_direction	last_message.message_direction	string	Szingular karakter, R vagy S, denoting, hogy ez az üzenet érkezett a partnertől, vagy küldött nekik, illetve.
response_by_username	last_message.response_by_username	string	Annak a szövegkérelem-felhasználónak a felhasználóneve, aki legutóbb üzenetet küldött ennek a felhasználónak.
message_timestamp_utc	last_message.message_timestamp_utc	string	Az üzenet elküldésének vagy fogadásának időbélyege.
delivery_status	last_message.delivery_status	string	Az üzenet aktuális állapota. Ez lehet "küldés", "kézbesítve", "hiba" vagy "küldés".
delivery_error	last_message.delivery_error	string	Hiba, amely miatt az üzenet nem érkezik meg. Ha a delivery_status nem "hiba", akkor ez az érték null értékű lesz.
mms_media	last_message.mms_media	array of string	Az üzenet mellékletére mutató URL-címek listája. Minden URL-cím szöveges kéréssel generált URL-cím lesz.

Törli a megadott telefonszámmal rendelkező partnert

Műveletazonosító:

DeleteContact

Törli a megadott telefonszámmal rendelkező partnert

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.
Kapcsolattartó telefonszáma	phone_number	True	string	A törölni kívánt partner telefonszáma.

Válaszok

response

string

Új csoport létrehozása

Műveletazonosító:

CreateGroup

Létrehoz egy új csoportot a megadott névvel.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.
Csoport neve	name		string	A csoport új neve.
Csoportosítási megjegyzés	notes		string	A csoportot leíró rövid kifejezés. Kényelmesen használható.

Válaszok

Name	Elérési út	Típus	Description
azonosító	id	integer	A csoport numerikus azonosítója.
group_member_count	group_member_count	integer	A csoport tagjainak száma.
is_keyword	is_keyword	boolean	Ez a csoport egy kulcsszócsoport. Az ilyen csoportok automatikusan létrejönnek, amikor egy felhasználó beállít egy kulcsszót. A rendszer a regisztrációkor automatikusan felveszi a névjegyeket.
név	name	string	A csoport neve.
jegyzetek	notes	string	A csoport bármely megjegyzése.
last_message_sent_utc	last_message_sent_utc	string	A csoport utolsó üzenetének elküldésének időbélyege.

Új fizetés létrehozása

Műveletazonosító:

CreatePayment

Új fizetést hoz létre a megadott üzenettel a megadott partnernek.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.
Fizetési leírás	description		string	A fizetés leírása. A leírás nem jelenik meg a partner számára, és csak a belső felhasználók használják a kifizetések kontextusához.
Címzett telefonszáma	customer_phone		string	A fizetési partner telefonszámát a rendszer elküldi.
Dollárban kért összeg	amount_requested		float	A kifizetés által kért dollárban megadott összeg.
Fizetési üzenet szövegtörzse	message		string	A partnernek küldendő üzenet szövege a fizetési hivatkozással együtt.
A fizetés referenciasztringje	reference_number		string	A fizetések létrehozásakor definiált felhasználó által definiált azonosító, amely a fizetések gyors megkeresésére használható. A hivatkozási számok nem egyediek; számos kifizetésnek lehet ugyanaz a referenciája.

Válaszok

Name	Elérési út	Típus	Description
payment_id	payment_id	integer	A fizetés numerikus azonosítója.
request_date	request_date	string	Annak időbélyege, amikor a kifizetés kezdeti üzenete üzenetsorba lett küldve.
címzett	recipient	string	A fizetési címzett neve. Ez null értékű lehet, ha a partnernek nincs a telefonszámához társított neve.
leírás	description	string	A fizetés leírása. Ez nem jelenik meg a partner számára. Csak a belső felhasználók használják a kifizetések kontextusához.
customer_phone	customer_phone	string	A fizetést küldő partner telefonszáma.
amount_requested	amount_requested	float	A kifizetés által kért dollárban megadott összeg.
is_past_due	is_past_due	boolean	Azt jelzi, hogy a kifizetés túllépi-e a kérelem dátumát.
reminder_was_sent	reminder_was_sent	boolean	Azt jelzi, hogy már küldött-e szöveges emlékeztetőt erre a fizetésre.
transaction_status	transaction_status	string	A tranzakció állapota az authvia-ban. Ez az érték ismeretlenként kezdődik.
textrequest_payment_status	textrequest_payment_status	string	A tranzakció állapota a Szöveges kérelemben. Ez azt az állapotot jelöli, amely a Szövegkérelem alkalmazás fizetési oldalán jelenik meg. Elküldve kezdődik.
reference_number	reference_number	string	A fizetések létrehozásakor definiált, felhasználó által definiált azonosító, amely a fizetések gyors megkeresésére használható. A hivatkozási számok nem egyediek; számos kifizetésnek lehet ugyanaz a referenciája.

Új irányítópult létrehozása a megadott névvel és telefonszámmal

Műveletazonosító:

CreateDashboard

Új irányítópultot hoz létre a fiókban. Az irányítópult létrehozása után a rendszergazdák e-mailben kapják meg a módosítást, és megkezdhetik a felhasználók hozzárendelését. Ez a végpont bármilyen kiépített számhoz létrehozhat irányítópultot. Egy adott területkódban kiépített számokat a GET /dashboards/provisioning használatával kereshet. Ha a telefonszám már használatban van, a rendszer egy hibás kérés kivételt küld.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
név	name		string	Az irányítópult neve.
phone	phone		string	Az irányítópulthoz társított szövegbeviteli szám.

Válaszok

Name	Elérési út	Típus	Description
azonosító	id	integer	Az irányítópult numerikus azonosítója.
név	name	string	Az irányítópult neve.
phone	phone	string	Az irányítópulthoz társított szövegbeviteli szám.

Üzenet küldése a megadott telefonszámmal rendelkező partnernek

Műveletazonosító:

SendMessageByPhoneNumber

Üzenet küldése (új beszélgetés indítása, ha a megadott telefonszámnak nincs üzenetelőzménye).

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
A hívás indításához az irányítópult azonosítója	dashboard_id	True	integer	A telefonszám irányítópult, amelyen dolgozni szeretne. Egyetlen fiók több irányítópulttal is rendelkezhet, amelyek különböző telefonvonalakat jelölnek az ügyfelek számára.
Telefonszám az üzenethez	phone_number	True	string	Annak a partnernek a telefonszáma, akinek üzenetet szeretne küldeni.
Üzenet szövege	body		string	A küldendő üzenet tartalma.
A feladó neve	sender_name		string	Az üzenet feladójának neve. Ez az üzenet beolvasásakor megjelenik a TextRequest webalkalmazásban és az API-ban.
Az üzenet állapotának frissítésekre vonatkozó visszahívási URL-címe	status_callback		string	A webalkalmazás URL-címe egy POST-paranccsal, amikor az üzenet állapota kézbesítetlenről elküldésre (vagy hibára) kerül.
Helykérések visszahívási URL-címe, ha az üzenet tartalmaz egy	location_callback		string	A helyvisszahívási URL-cím a POST paranccsal való kereséshez, amikor a felhasználó hozzáfér, és jóváhagyja a tartózkodási hely megosztását a feladóval. A hivatkozás hozzáadásához adja hozzá a [Helykérés] elemet az üzenet törzséhez. Ez a visszahívás nem szükséges a helykérésekhez, de az API-k esetében hasznos lehet.
MMS Media-mellékletek ehhez az üzenethez	mms_media		array of string	Az üzenet MMS-médiamellékleteinek tömbje. A mellékleteknek a post/mms végpontról kapott URL-címeknek kell lenniük (az összekötő nem tartalmazza). A külső melléklethivatkozások nem lesznek elfogadva.

Válaszok

Name	Elérési út	Típus	Description
message_id	message_id	string	Az üzenet azonosítója. Ez az érték minden üzenethez egyedi.
body	body	string	Az üzenet tartalma.
message_direction	message_direction	string	Szingular karakter, R vagy S, denoting, hogy ez az üzenet érkezett a partnertől, vagy küldött nekik, illetve.
response_by_username	response_by_username	string	Annak a szövegkérelem-felhasználónak a felhasználóneve, aki legutóbb üzenetet küldött ennek a felhasználónak.
message_timestamp_utc	message_timestamp_utc	string	Az üzenet elküldésének vagy fogadásának időbélyege.
delivery_status	delivery_status	string	Az üzenet aktuális állapota. Ez lehet "küldés", "kézbesítve", "hiba" vagy "küldés".
delivery_error	delivery_error	string	Hiba, amely miatt az üzenet nem érkezik meg. Ha a delivery_status nem "hiba", akkor ez az érték null értékű lesz.
mms_media	mms_media	array of string	Az üzenet mellékletére mutató URL-címek listája. Minden URL-cím szöveges kéréssel generált URL-cím lesz.

Triggerek

Eseményindítók szöveg küldésekor vagy fogadásakor

Eseményindítók szöveg küldésekor vagy fogadásakor

Eseményindítók szöveg küldésekor vagy fogadásakor

Műveletazonosító:

TextingWebhook

Eseményindítók szöveg küldésekor vagy fogadásakor

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Irányítópult, amelyről az eseményindító figyeli az eseményeket	dashboard_id	True	string	Az irányítópult azonosítója, amelyhez eseményindítót szeretne hozzáadni
esemény	event	True	string	esemény

Válaszok

Name	Elérési út	Típus	Description
Egyedi üzenetazonosító	messageUniqueIdentifier	string	messageUniqueIdentifier
Fiók azonosítója	account.id	integer	azonosító
Beszélgetés azonosítója	yourPhoneNumber.id	integer	azonosító
Irányítópult neve	yourPhoneNumber.description	string	leírás
Irányítópult telefonszáma	yourPhoneNumber.phoneNumber	string	telefonszám
Irányítópult azonosítója	conversation.id	integer	azonosító
date	conversation.date	string	date
Kapcsolattartó telefonszáma	conversation.consumerPhoneNumber	string	consumerPhoneNumber
messageDirection	conversation.messageDirection	string	messageDirection
üzenet	conversation.message	string	üzenet
numSegments	conversation.numSegments	integer	numSegments
állapot	conversation.status	string	állapot
A beszélgetést a következő állította be:	conversation.claimedBy	string	claimedBy
Névjegy megjelenítendő neve	conversation.consumerFriendlyName	string	consumerFriendlyName

Definíciók

karakterlánc

Ez a sztring alapszintű adattípusa.