Textbegäran

Textbegäran är en plattform för affärstext som skapats för att väcka kundengagemang. Vi har skapat en plug-and-play-meddelandelösning för dina dagliga kommunikationsproblem, så att du kan minska bruset och ansluta till kunder när som helst, var som helst. Läs mer om hur vi hjälper upptagna företagsledare som du.

Den här anslutningsappen är tillgänglig i följande produkter och regioner:

Tjänster	Class	Regioner
Copilot Studio	Premie	Alla Power Automate-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD)
Logiska appar	Norm	Alla Logic Apps-regioner utom följande: – Azure Government-regioner – Regioner i Azure Kina - US Department of Defense (DoD)
Power Apps	Premie	Alla Power Apps-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD)
Power Automate	Premie	Alla Power Automate-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD)

Kontakt
Namn	Api-stöd för textbegäran
URL	https://www.textrequest.com/contact
E-postmeddelande	apidev@textrequest.com

Metadata för anslutningsprogram
Utgivare	Textbegäran
Webbplats	https://www.textrequest.com/
Sekretesspolicy	https://www.textrequest.com/privacy-policy/
Kategorier	Kommunikation; Försäljning och CRM

Aranda Service Management Suite (ASMS)

Öka företagets produktivitet och omvandla användarnas upplevelse med Aranda Service Management Suite, den lösning för flera innehavare som gör att du kan hantera, integrera och automatisera affärsprocesser och tjänster. Skapa, söka efter och uppdatera poster som lagras på alla arbetsytor (projekt) i ASMS, inklusive incidenter, krav och ändringar, bland annat.

Pre-requisites

Tänk på följande förutsättningar för att fortsätta:

En prenumeration och en instans av Aranda Service Management Suite (ASMS). Börja här: https://arandasoft.com/
En aktiv Microsoft Power Automate-prenumeration med premiumanslutningsfunktioner.

Hämta autentiseringsuppgifter

Använd integrationstoken för att utföra autentisering. I följande länk hittar du information om hur du hämtar integrationstoken

Kom igång med anslutningsappen

Kräver en prenumeration på Aranda Service Management Suite (ASMS).
Hämta integrationstoken
Hämta instans-URL:en för Aranda Service Management ASMS API (ApiAsms).
Upprätta en anslutning med Aranda Service Management Suite-anslutningsappen.
Välj någon av följande funktioner som erbjuds av anslutningsappen:
Detaljerad dokumentation om anslutningsappen finns i https://docs.arandasoft.com/connectors

Du kan använda den här anslutningsappen i följande fall:

Skapa, söka efter och uppdatera biljetter, bland andra tillgängliga åtgärder.
Hämta spårning av biljetter.
Ladda ned bifogade filer som är relaterade till ett ärende.
Sök efter kunskapsbasartiklar (KB) i Aranda Service Management Suite.
Ladda ned bifogade filer från kunskapsbasartiklar (KB).
Skapa, söka efter och uppdatera konfigurationsobjekt (CIs).
Det gör det möjligt för organisationer att lösa sina interna supportförfrågningar, hantera och effektivisera den tekniska problemlösningsprocessen.
Tillåter spårning av kommunikation mellan beställare och supportagenter.
Erbjuda automatiserade svar för att informera begärande om status för deras biljett.

Lyckat svar

Kod	Namn	Description
200	OK	Begäran lyckades
204	NoContent	Inga data hittades i begäran

Vanliga fel och åtgärder

Kod	Namn	Description	Lösning
400	Felaktig Begäran	CriteriaNeedsSomeArguments	Kontrollera att sökparametrarna inte är tomma
400	Felaktig Begäran	InvalidAdditionalFieldId	Kontrollera att ID:na för de ytterligare fälten är korrekta
400	Felaktig Begäran	InvalidItemType	Ärendetypen är felaktig, ändra ärendetyps-ID:t
400	Felaktig Begäran	InvalidProjectId	Projekt-ID:t är felaktigt, ändra det projekt-ID som du ska associera ärendet med
400	Felaktig Begäran	InvalidStateId	Kontrollera den tillagda statusen när du skapar eller uppdaterar en biljett
400	Felaktig Begäran	InvalidUploadType	Ett fel uppstod när en fil skulle bifogas. Begär hjälp från en systemadministratör
400	Felaktig Begäran	RequestNeedsSomeArguments	Kontrollera de obligatoriska fälten i biljetten och lägg till motsvarande värde för dessa i anslutningsappen
400	Felaktig Begäran	SearchListIsRequired	Begär hjälp från en systemadministratör
400	Felaktig Begäran	Parameternamn: {Namnparameter}	Kontrollera att egenskaperna som nämns i felet inte är null
400	Felaktig Begäran	Är null-parameternamn: {Name parameter}	Kontrollera att egenskaperna som nämns i felet inte är null
400	Felaktig Begäran	ItemTypeIsRequired	Lägg till skiftlägestyp
400	Felaktig Begäran	ModelIdIsEmpty	Lägg till parametern modelId. Det krävs.
400	Felaktig Begäran	StateIdIsEmpty	Lägg till parametern stateId. Det krävs.
400	Felaktig Begäran	ServiceIdIsEmpty	Lägg till parametern serviceId. Det krävs.
400	Felaktig Begäran	CategoryIdIsEmpty	Lägg till parametern categoryId. Det krävs.
400	Felaktig Begäran	TypesListNeedsSomeArguments	Kräver att du lägger till typen av ärende när du söker efter biljetter, Begär hjälp från en systemadministratör
400	Felaktig Begäran	{PARAMETER_NAME} AdditionalFieldIsRequired	Det ytterligare fältet {PARAMETER_NAME} är obligatoriskt
400	Felaktig Begäran	ModelNotActive	Modellen som är associerad med ärendet är inte aktiv
400	Felaktig Begäran	FailedToCloseTaskPendingCloseTasksPredecessors	Om du försöker stänga ärendet och det överordnade ärendet har väntande uppgifter att stänga
400	Felaktig Begäran	DuplicatedObject	Ci finns redan i databasen
400	Felaktig Begäran	EmptyValue-parameternamn: {PARAMETER_NAME}	Parametern {PARAMETER_NAME} krävs
400	Felaktig Begäran	EmptyEnumeration Parameter name: {PARAMETER_NAME}	Parametern {PARAMETER_NAME} är en lista och krävs
403	Ej tillåtet	DoNotHavePermissionForThisAction	Prata med systemadministratören för att tilldela behörigheter

Kod	Namn	Description	Lösning
500	InternalServerError		Begär hjälp från en systemadministratör
500	InternalServerError	FailureExportExcel	Begär hjälp från en systemadministratör
500	InternalServerError	FailureGetAdditionalFields	Begär hjälp från en systemadministratör
500	InternalServerError	FailureGetCategoriesByService	Begär hjälp från en systemadministratör
500	InternalServerError	FailureGetChangeFSC	Begär hjälp från en systemadministratör
500	InternalServerError	FailureGetFields	Begär hjälp från en systemadministratör
500	InternalServerError	FailureGetFieldsList	Begär hjälp från en systemadministratör
500	InternalServerError	FailureGetFiles	Begär hjälp från en systemadministratör
500	InternalServerError	FailureGetLookupValues	Begär hjälp från en systemadministratör
500	InternalServerError	FailureGetMailTemplates	Begär hjälp från en systemadministratör
500	InternalServerError	FailureGetModelByCategory	Begär hjälp från en systemadministratör
500	InternalServerError	FailureGetOperators	Begär hjälp från en systemadministratör
500	InternalServerError	FailureGetReassignmentReasons	Begär hjälp från en systemadministratör
500	InternalServerError	FailureGetSimilarItems	Begär hjälp från en systemadministratör
500	InternalServerError	FailureSearchQuickManagement	Begär hjälp från en systemadministratör

Vanliga frågor

Hur hämtar du ID:n för de attribut som krävs för att använda de olika åtgärderna i anslutningsappen (t.ex. projekt, tjänst, kategori, grupp, specialist)?

ID:na kan hämtas på många sätt:
- Med Aranda Query Manager kan du skapa en rapport som frågar asMS-tabellen (Aranda Service Management Suite) där nödvändiga data finns. Om du behöver vägledning om dataobjekten i lösningen kan du gå till följande länk https://docs.arandasoft.com/docs/database.html och identifiera den Aranda-databasversion som motsvarar din ASMS-installation.
- Om du använder en lokal ASMS-installation kan du fråga ASMS-tabellen där nödvändiga data finns via en SQL-klient.
- Via Aranda Support Center skapar du en supportbegäran via kontaktkanalerna som anges på följande webbplatsSupport.
Vilken är den maximala storleken på filer som ska bifogas när du använder åtgärden Lägg till bifogad fil?

Den maximala storleken beror på den specifika konfigurationen av din ASMS-instans/installation. Fråga ASMS-administratören.
Vilken dataåtkomstnivå krävs av det teknikerkonto vars token används i konfigurationen av ASMS-anslutningen som krävs av anslutningsappen?

Åtkomstnivån är samma som teknikerkontot som används i ASMS regelbundet. Med andra ord, baserat på rollerna och behörigheterna för motsvarande tekniker i ASMS, kan data nås med anslutningsappen.
Ska det teknikerkonto vars token ska användas i anslutningsappen vara Namngiven eller Samtidig?

Eftersom anslutningsappen kan komma åt den relaterade ASMS-instansen flera gånger per timme rekommenderar vi starkt att kontot är en namngiven typ.
Följer skapandet eller ändringen av ärenden med hjälp av anslutningsappen samma dataverifieringsregler som finns i ASMS-gränssnittet?

Ja, den följer samma valideringsregler. När du till exempel skapar ett ärende för ett specifikt projekt, tjänst och kategori, om interna och ytterligare fält måste fyllas i, krävs även dessa data när ärendet skickas via anslutningsappen.
Kan anslutningsappen användas för ASMS-instanser i moln- och lokala miljöer?

Ja, den kan användas i både molninstallationer och lokala installationer av ASMS. I Lokala installationer måste du överväga anslutningen mellan ASMS-servern och Din Power Automate-miljö.
Jag har en Power Automate-licens som bara tillåter mig att använda Standard-anslutningsappar. Kan jag använda ASMS-anslutningsappen?

Det är inte möjligt, ASMS-anslutningsappen är premiumtyp.
Jag vill skapa flöden i Power Automate som startar från händelser i ASMS (t.ex. när ett ärende har skapats, när ett ärende har tilldelats till en viss grupp). Är det möjligt att använda utlösare som startar från händelser som inträffar i ASMS?

Ja, det är möjligt. Följande steg rekommenderas:
- Initiera en utlösare "När en HTTP-begäran tas emot" och skapa ett JSON-schema för begärandetext som innehåller den datastruktur som förväntas tas emot från ASMS. När utlösaren har skapats får du en HTTP POST-URL (WebHook URL) som ska användas i din ASMS-instans. Glöm inte att överväga autentiseringsmekanismen för att komma åt WebHook-URL:en (t.ex. token).
- Skapa en affärsregel i ASMS för de villkor som när de uppfylls ska initiera flödet i Power Automate. Som en åtgärd i regeln väljer du "Anropa Webhook" och i mål-URL:en för anrop anger du den tidigare hämtade WebHook-URL:en, parametrarna som ska skickas och brödtexten för begäran (som måste matcha JSON-schemat för begärandetext). Mer information om hur du anropar en webhook från en regel i ASMS finns på följande länk: Webhook-regel
- Testa den skapade regeln och verifiera att en HTTP-begäran skickas till WebHook-URL:en och initierar flödet i Power Automate.
Kan jag anropa ASMS REST API-slutpunkter som åtgärder från flöden i Power Automate?

Ja, det är möjligt. Använd åtgärden "HTTP" och fyll i nödvändiga data i den (bland annat URI, Metod, Rubriker, Brödtext).

Skapa en anslutning

Anslutningsappen stöder följande autentiseringstyper:


Standardinställning	Parametrar för att skapa anslutning.	Alla regioner	Går inte att dela

Standard

Tillämpligt: Alla regioner

Parametrar för att skapa anslutning.

Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.

Namn	Typ	Description	Krävs
API-nyckel	securestring	API-nyckeln för det här API:et	Sann

Begränsningsgränser

Name	Anrop	Förnyelseperiod
API-anrop per anslutning	100	60 sekunder

Åtgärder

Arkivera en konversation	Arkiverar en konversation och tar bort den från resultatet av alla slutpunkter för konversationshämtning. En konversation tas automatiskt ur funktion om kunden skickar en text till ditt textbegäransnummer, eller om du skickar en text till kunden från ditt textbegäransnummer. Arkivering av konversationer är ett bra sätt att ta bort oreda från kunder som du inte planerar att prata med i framtiden. Observera att om en kund sms:ar i "STOP" för att förhindra att du skickar dem ytterligare SMS arkiveras konversationen automatiskt.
Avbryter den angivna betalningen	Avbryter den angivna betalningen och sms:ar användaren att betalningen har avbrutits. Betalningar kan inte redigeras, så att avbryta och utfärda en ny betalning är det bästa sättet att korrigera en betalning.
Hämta alla instrumentpaneler i ett konto	Hämtar alla instrumentpaneler i ett konto.
Hämta alla kontakter som matchar det angivna filtreringskriteriet	Hämtar alla kontakter som matchar det angivna filtreringskriteriet. Endast den angivna instrumentpanelen söks igenom. det finns ingen sökning på kontonivå efter ett tal tillgängligt.
Hämta en grupp efter dess ID	Hämtar gruppen med det angivna ID:t.
Hämta en konversations meddelanden via en kontakts telefonnummer	Hämta konversationen mellan den angivna instrumentpanelen och telefonnumret.
Hämta information på den här specifika instrumentpanelen	Returnerar instrumentpanelens namn och telefon.
Hämtar alla anpassade fält	Hämtar alla anpassade fält för den här instrumentpanelen. Anpassade fält är unika mellan instrumentpaneler.
Hämtar alla betalningar	Hämtar alla betalningar, inklusive annullerade och betalda betalningar. Dessa kan filtreras med hjälp av frågeparametrarna.
Hämtar alla grupper	Hämtar alla grupper för användarens konto.
Hämtar alla konversationer för den här instrumentpanelen	Hämtar alla konversationer för den här instrumentpanelen och innehåller information om det sista meddelandet för varje konversation.
Hämtar alla taggar	Hämtar alla taggar för den här instrumentpanelen. Taggar är unika mellan instrumentpaneler.
Hämtar betalningen med det angivna ID:t	Hämtar betalningen med det angivna ID:t.
Hämtar kontakten med det angivna telefonnumret	Hämtar kontakten med det angivna telefonnumret
Markera en betalning som betald	Stänger en betalning som "betald". Använd den här slutpunkten för när betalningen betalas via ett annat sätt än portalen för betalningsbegäran. Då stängs betalningen och dess betalningsbelopp läggs till i din statistik. Den här slutpunkten krävs inte för betalningar som betalas via betalningsportalen som skickas via textbegäran. som automatiskt markerar en betalning som betald.
Massuppdateringskontakter	Endast den angivna instrumentpanelen har kontakter tillagda. kontakter ordnas efter instrumentpanel och det finns ingen sökning på kontonivå efter ett tal tillgängligt.
Skapa eller uppdatera en kontakt	Skapar eller uppdaterar en kontakt (beroende på om det redan finns en kontakt med det angivna telefonnumret).
Skapa en ny instrumentpanel med förnamn och telefonnummer	Skapar en ny instrumentpanel i kontot. När instrumentpanelen har skapats får administratörer ett e-postmeddelande om ändringen och kan börja tilldela användare. Den här slutpunkten kan skapa en instrumentpanel för alla etablerade tal. Du kan söka efter etablerade nummer i en specifik riktnummer med get /dashboards/provisioning. Om telefonnumret redan används utlöses ett undantag för felaktig begäran.
Skapar en ny betalning	Skapar en ny betalning med det angivna meddelandet till den angivna kontakten.
Skapar en ny grupp	Skapar en ny grupp med det angivna namnet.
Skicka en uppföljningstext som påminner användaren om att betala den angivna betalningen	Skickar en påminnelse till kontakten om att betala den angivna betalningen. Innehållet i meddelandet genereras automatiskt. För att undvika skräppost kan bara en påminnelse skickas per betalning
Skicka ett meddelande till kontakten med det angivna telefonnumret	Skickar ett meddelande (startar en ny konversation om det angivna telefonnumret inte har någon meddelandehistorik).
Tar bort den angivna instrumentpanelen	Tar bort den angivna instrumentpanelen.
Tar bort gruppen med det angivna ID:t	Tar bort gruppen med det angivna ID:t. Detta lyckas även om det finns kontakter som är medlemmar i gruppen (kontakterna tas inte bort).
Tar bort kontakten med det angivna telefonnumret	Tar bort kontakten med det angivna telefonnumret
Unarchive a Conversation	Unarchives en konversation. När en konversation har tagits bort visas den återigen i kön. Den visas också i konversationer som returneras av slutpunkten /conversations. Om en konversation redan är oarchiverad har den här metoden ingen effekt.
Uppdatera en specifik instrumentpanels namn	Uppdaterar en instrumentpanel. Detta ändrar inte en instrumentpanels telefonnummer. Om du vill ha ett nytt nummer med en annan instrumentpanels kontakter måste du skapa en ny instrumentpanel med en POST och lägga till kontakterna med en massexport/import.
Uppdaterar en grupp med det angivna ID:t	Uppdaterar en grupps namn med hjälp av gruppens numeriska ID. Om det skickade grupp-ID:t inte finns misslyckas anropet.

Arkivera en konversation

Åtgärds-ID:: ArchiveConversation

Arkiverar en konversation och tar bort den från resultatet av alla slutpunkter för konversationshämtning. En konversation tas automatiskt ur funktion om kunden skickar en text till ditt textbegäransnummer, eller om du skickar en text till kunden från ditt textbegäransnummer. Arkivering av konversationer är ett bra sätt att ta bort oreda från kunder som du inte planerar att prata med i framtiden. Observera att om en kund sms:ar i "STOP" för att förhindra att du skickar dem ytterligare SMS arkiveras konversationen automatiskt.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.
Telefonnummer för konversation	phone_number	True	string	Telefonnumret för konversationen som ska arkiveras.

Returer

response: string

Avbryter den angivna betalningen

Åtgärds-ID:: CancelPayment

Avbryter den angivna betalningen och sms:ar användaren att betalningen har avbrutits. Betalningar kan inte redigeras, så att avbryta och utfärda en ny betalning är det bästa sättet att korrigera en betalning.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.
ID för betalningen	payment_id	True	integer	Det numeriska ID:t för betalningen som ska uppdateras.

Returer

Name	Sökväg	Typ	Description
payment_id	payment_id	integer	Det numeriska ID:t för betalningen.
request_date	request_date	string	Tidsstämpeln för när den här betalningens första meddelande köades för att skickas.
mottagare	recipient	string	Namnet på betalningsmottagaren. Detta kan vara null om kontakten inte har något namn kopplat till sitt telefonnummer.
beskrivning	description	string	Beskrivning av betalningen. Detta visas inte för kontakten. Den används endast av interna användare för kontext om betalningar.
customer_phone	customer_phone	string	Telefonnumret till den kontakt som skickas den här betalningen.
amount_requested	amount_requested	float	Beloppet i dollar som begärs av den här betalningen.
is_past_due	is_past_due	boolean	Om den här betalningen har passerat begärandedatumet.
reminder_was_sent	reminder_was_sent	boolean	Om en textpåminnelse redan har skickats för den här betalningen.
transaction_status	transaction_status	string	Status för transaktionen i authvia. Det här värdet börjar som Okänt.
textrequest_payment_status	textrequest_payment_status	string	Status för transaktionen i textbegäran. Detta representerar den status som visas på betalningssidan i appen Textbegäran. Det börjar som Skickat.
reference_number	reference_number	string	Det användardefinierade ID som definieras när betalningar skapas som kan användas för att snabbt hitta betalningar. Referensnummer är inte unika. många betalningar kan ha samma referens.

Hämta alla instrumentpaneler i ett konto

Åtgärds-ID:: GetDashboards

Hämtar alla instrumentpaneler i ett konto.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Nummersida att hämta	page		integer	Sidan med entiteter som ska hämtas. När du hämtar värden finns det en maximal storlek per sida, definierad av page_size. Om sidan är större än den sista sidan returneras en tom matris.
Belopp för varje entitet som ska hämtas per sida	page_size		integer	Storleken på varje sida som ska hämtas. När du hämtar värden är detta en maximal storlek per sida, med åtkomst till efterföljande sidor som görs av sidparametern.

Returer

Name	Sökväg	Typ	Description
sida	meta.page	integer	Sidan med entiteter som har tagits fram. Mängden entiteter på den här sidan definieras av page_size.
page_size	meta.page_size	integer	Antalet entiteter som finns på den här sidan.
total_items	meta.total_items	integer	Antalet entiteter som är tillgängliga i databasen, oavsett sidstorlek eller nummer. Om du vill se de andra sidorna ändrar du sidnumret i begäran.
items	items	array of object	Lista över instrumentpanelsentiteter som hämtats från textbegäran.
Id-nummer	items.id	integer	Instrumentpanelens numeriska ID.
name	items.name	string	Namnet på instrumentpanelen.
phone	items.phone	string	Textnumret som är associerat med den här instrumentpanelen.

Hämta alla kontakter som matchar det angivna filtreringskriteriet

Åtgärds-ID:: GetContacts

Hämtar alla kontakter som matchar det angivna filtreringskriteriet. Endast den angivna instrumentpanelen söks igenom. det finns ingen sökning på kontonivå efter ett tal tillgängligt.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kontaktens telefonnummer att söka efter	contact_phone_number		string	Telefonnummer som kontakter ska filtreras efter.
Söktidsstämpeln "Senaste meddelandetid skickad före" i UTC-tid	last_message_timestamp_before_utc		date-time	Tidsgräns för att söka efter kontakter efter det senaste meddelandet som skickades eller togs emot. Inga kontakter som skickade meddelanden efter den här tiden visas.
Söktidsstämpeln "Senaste meddelandetid skickad efter" i UTC-tid	last_message_timestamp_after_utc		date-time	Tidsgräns för att söka efter kontakter efter det senaste meddelandet som skickades eller togs emot. Inga kontakter vars senast skickade meddelande är före den här tiden visas.
Söktidsstämpeln "Skapad före"	contact_created_before		date-time	Tid för att söka efter kontakter efter när de skapades. Inga kontakter som skapats efter den här tiden visas.
Tidsstämpel för "Skapad efter"-sökning	contact_created_after		date-time	Tid för att söka efter kontakter efter när de skapades. Inga kontakter som skapats före den här tiden visas.
Om kontaktens konversation är löst	is_resolved		boolean	Om du vill söka efter kontakter vars konversationer har lösts.
Om kontakten är blockerad	is_blocked		boolean	Om du vill söka efter kontakter som har blockerats.
Om kontakten är arkiverad	is_archived		boolean	Om du vill söka efter kontakter som har arkiverats.
Om kontakten ignoreras	is_suppressed		boolean	Om du vill söka efter kontakter som har undertryckts.
Om kontakten har avregistrerat sig	has_opted_out		boolean	Om du vill söka efter kontakter som har avanmält sig från att ta emot sms.
Tidsstämpeln "Senaste meddelandetid skickad före"	last_message_sent_before		date-time	Tidsgräns för att söka efter kontakter efter när det senaste meddelandet skickades till kunden. Inga kontakter som skickade meddelanden efter den här tiden visas. Använder tidsstämpeln som lokal tid. Om du vill filtrera efter tidsstämpel i UTC-tid använder du last_message_sent_before_utc
Tidsstämpel för "Senaste meddelande-tid som skickats efter"	last_message_sent_after		date-time	Tidsgräns för att söka efter kontakter efter när det senaste meddelandet skickades till kunden. Inga kontakter vars senast skickade meddelande är före den här tiden visas. Använder tidsstämpeln som lokal tid. Om du vill filtrera efter tidsstämpel i UTC-tid använder du last_message_sent_after_utc
Söktidsstämpeln "Senaste meddelandetid mottagen före"	last_message_received_before		date-time	Tidsgräns för att söka efter kontakter efter det senaste meddelandet som togs emot från kunden. Inga kontakter som tog emot meddelanden efter den här tiden visas. Använder tidsstämpeln som lokal tid. Om du vill filtrera efter tidsstämpel i UTC-tid använder du last_message_sent_before_utc
Tidsstämpeln "Senaste meddelandetid mottagen efter"	last_message_received_after		date-time	Tidsgräns för att söka efter kontakter efter det senaste meddelandet som togs emot från kunden. Inga kontakter vars senast skickade meddelande är före den här tiden visas. Använder tidsstämpeln som lokal tid. Om du vill filtrera efter tidsstämpel i UTC-tid använder du last_message_sent_before_utc
Kontakttaggar	tags		string	Kommaavgränsad lista över guids som refererar till taggar för att filtrera kontakter efter.
Kontaktgrupper	groups		string	Kommaavgränsad lista över heltals-ID:er som refererar till grupper att filtrera kontakter efter.
ID för anpassat fält som ska filtreras efter	custom_field_id_1		string	Guid som refererar till anpassat fält för att filtrera kontakter efter.
Värdet för det anpassade fält som ska filtreras efter	custom_field_value_1		string	Värde som refererar till anpassat fält för att filtrera kontakter efter.
ID för det andra anpassade fältet som ska filtreras efter	custom_field_id_2		string	Guid som refererar till det andra anpassade fältet för att filtrera kontakter efter.
Värdet för det andra anpassade fältet som ska filtreras efter	custom_field_value_2		string	Värde som refererar till det andra anpassade fältet för att filtrera kontakter efter.
ID för det tredje anpassade fältet som ska filtreras efter	custom_field_id_3		string	Guid som refererar till det tredje anpassade fältet för att filtrera kontakter efter.
Värdet för det tredje anpassade fältet som ska filtreras efter	custom_field_value_3		string	Värde som refererar till det tredje anpassade fältet för att filtrera kontakter efter.
Nummersida att hämta	page	True	integer	Sidan med entiteter som ska hämtas. När du hämtar värden finns det en maximal storlek per sida, definierad av page_size. Om sidan är större än den sista sidan returneras en tom matris.
Belopp för varje entitet som ska hämtas per sida	page_size	True	integer	Storleken på varje sida som ska hämtas. När du hämtar värden är detta en maximal storlek per sida, med åtkomst till efterföljande sidor som görs av sidparametern.
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.

Returer

Name	Sökväg	Typ	Description
sida	meta.page	integer	Sidan med entiteter som har tagits fram. Mängden entiteter på den här sidan definieras av page_size.
page_size	meta.page_size	integer	Antalet entiteter som finns på den här sidan.
total_items	meta.total_items	integer	Antalet entiteter som är tillgängliga i databasen, oavsett sidstorlek eller nummer. Om du vill se de andra sidorna ändrar du sidnumret i begäran.
items	items	array of object	Lista över kontaktentiteter som hämtats från textbegäran.
telefonnummer	items.phone_number	string	Telefonnummer för den här kontakten.
first_name	items.first_name	string	Förnamn för den här kontakten.
last_name	items.last_name	string	Efternamn på den här kontakten.
display_name	items.display_name	string	Fullständigt namn på den här kontakten. Det här är standardnamnet som visas i webbappen när kontakter visas.
is_suppressed	items.is_suppressed	boolean	Om konversationen med den här kontakten ignoreras och därför inte skickas överst i meddelandekön när den tas emot.
is_archived	items.is_archived	boolean	Om konversationen med den här kontakten arkiveras och därför inte kan visas vid frågor mot konversationer (som standard).
is_blocked	items.is_blocked	boolean	Om konversationen med den här kontakten blockeras och därför inte tas emot eller lagras.
suppressed_reason	items.suppressed_reason	string	Fras som beskriver orsaken till att kontakten inte används. Om is_suppressed är falskt blir det null.
not	items.note	string	Kort fras som beskriver kontakt. Används för enkelhetens skull. Detta visas aldrig för kontakten.
groups	items.groups	array of integer	Matris med heltals-ID:t som refererar till grupper som kontakten tillhör.
contact_tags	items.contact_tags	array of string	Matris med guids som refererar till taggar som är kopplade till den här kontakten.
custom_fields	items.custom_fields	array of object	Matris med anpassade fält-ID:er och värden som definierats för den här kontakten.
Id-nummer	items.custom_fields.id	string	Guid som refererar till ett anpassat fält.
värde	items.custom_fields.value	string	Den här kontaktens värde för det här anpassade fältet.
is_resolved	items.is_resolved	boolean	Om konversationen med den här kontakten är löst. Alla nya texter som tas emot av denna kontakt kommer att ange detta falskt.
first_contact_utc	items.first_contact_utc	string	Tidsstämpel för när det första meddelandet skickades till den här kontakten.
opted_out_utc	items.opted_out_utc	string	Tidsstämpel för när den här kontakten valde att ta emot meddelanden.
last_msg_sent_utc	items.last_msg_sent_utc	string	Tidsstämpel för när det senaste meddelandet skickades till den här kontakten.
last_msg_received_utc	items.last_msg_received_utc	string	Tidsstämpel för när det senaste meddelandet togs emot från den här kontakten.
total_msgs_sent	items.total_msgs_sent	integer	Antalet meddelanden som skickats till den här kontakten.
total_msgs_received	items.total_msgs_received	integer	Antalet totalt antal meddelanden som tagits emot från den här kontakten.
response_count	items.response_count	integer	Totalt antal svarsmeddelanden från kontakten.
date_created_utc	items.date_created_utc	string	Tidsstämpel för när kontakterna skapades.
last_contact_date_utc	items.last_contact_date_utc	string	Tidsstämpel för när det senaste meddelandet skickades eller togs emot från den här kontakten.
message_id	items.last_message.message_id	string	Id för meddelandet. Det här värdet är unikt för varje meddelande.
body	items.last_message.body	string	Innehållet i det här meddelandet.
message_direction	items.last_message.message_direction	string	Singulartecken, antingen R eller S, som anger om det här meddelandet togs emot från kontakten eller skickades till dem.
response_by_username	items.last_message.response_by_username	string	Användarnamn för den textbegärandeanvändare som senast skickade ett meddelande till den här användaren.
message_timestamp_utc	items.last_message.message_timestamp_utc	string	Tidsstämpel för när meddelandet skickades eller togs emot av textbegäran.
delivery_status	items.last_message.delivery_status	string	Aktuell status för det här meddelandet. Det kan vara "skicka", "levererad", "fel" eller "skicka".
delivery_error	items.last_message.delivery_error	string	Fel som gjorde att meddelandet inte levererades. Om delivery_status inte är "fel" är det här värdet null.
mms_media	items.last_message.mms_media	array of string	Lista över URL:er som pekar på det här meddelandets bifogade filer. Alla URL:er är textbegärandegenererade URL:er.

Hämta en grupp efter dess ID

Åtgärds-ID:: GetGroupById

Hämtar gruppen med det angivna ID:t.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.
ID för gruppen	group_id	True	integer	Det numeriska ID för gruppen som ska hämtas.

Returer

Name	Sökväg	Typ	Description
Id-nummer	id	integer	Gruppens numeriska ID.
group_member_count	group_member_count	integer	Antalet medlemmar i gruppen.
is_keyword	is_keyword	boolean	Den här gruppen är en nyckelordsgrupp. Sådana grupper genereras automatiskt när en användare konfigurerar ett nyckelord. Kontakter läggs automatiskt till när de registreras.
name	name	string	Namnet på den här gruppen.
Anteckningar	notes	string	Eventuella anteckningar om den här gruppen.
last_message_sent_utc	last_message_sent_utc	string	Tidsstämpel för när det senaste gruppmeddelandet skickades för den här gruppen.

Hämta en konversations meddelanden via en kontakts telefonnummer

Åtgärds-ID:: GetMessagesByContactPhone

Hämta konversationen mellan den angivna instrumentpanelen och telefonnumret.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Nummersida att hämta	page	True	integer	Sidan med entiteter som ska hämtas. När du hämtar värden finns det en maximal storlek per sida, definierad av page_size. Om sidan är större än den sista sidan returneras en tom matris.
Belopp för varje entitet som ska hämtas per sida	page_size	True	integer	Storleken på varje sida som ska hämtas. När du hämtar värden är detta en maximal storlek per sida, med åtkomst till efterföljande sidor som görs av sidparametern.
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.
Kontaktens telefonnummer att söka efter	phone_number	True	string	Telefonnummer för kontakten att hämta meddelanden för.

Returer

Name	Sökväg	Typ	Description
sida	meta.page	integer	Sidan med entiteter som har tagits fram. Mängden entiteter på den här sidan definieras av page_size.
page_size	meta.page_size	integer	Antalet entiteter som finns på den här sidan.
total_items	meta.total_items	integer	Antalet entiteter som är tillgängliga i databasen, oavsett sidstorlek eller nummer. Om du vill se de andra sidorna ändrar du sidnumret i begäran.
items	items	array of object	Lista över meddelandeentiteter som hämtats från textbegäran.
message_id	items.message_id	string	Id för meddelandet. Det här värdet är unikt för varje meddelande.
body	items.body	string	Innehållet i det här meddelandet.
message_direction	items.message_direction	string	Singulartecken, antingen R eller S, som anger om det här meddelandet togs emot från kontakten eller skickades till dem.
response_by_username	items.response_by_username	string	Användarnamn för den textbegärandeanvändare som senast skickade ett meddelande till den här användaren.
message_timestamp_utc	items.message_timestamp_utc	string	Tidsstämpel för när meddelandet skickades eller togs emot av textbegäran.
delivery_status	items.delivery_status	string	Aktuell status för det här meddelandet. Det kan vara "skicka", "levererad", "fel" eller "skicka".
delivery_error	items.delivery_error	string	Fel som gjorde att meddelandet inte levererades. Om delivery_status inte är "fel" är det här värdet null.
mms_media	items.mms_media	array of string	Lista över URL:er som pekar på det här meddelandets bifogade filer. Alla URL:er är textbegärandegenererade URL:er.

Hämta information på den här specifika instrumentpanelen

Åtgärds-ID:: GetDashboard

Returnerar instrumentpanelens namn och telefon.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.

Returer

Name	Sökväg	Typ	Description
Id-nummer	id	integer	Instrumentpanelens numeriska ID.
name	name	string	Namnet på instrumentpanelen.
phone	phone	string	Textnumret som är associerat med den här instrumentpanelen.

Hämtar alla anpassade fält

Åtgärds-ID:: GetCustomFields

Hämtar alla anpassade fält för den här instrumentpanelen. Anpassade fält är unika mellan instrumentpaneler.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.

Returer

Name	Sökväg	Typ	Description
		array of object
Id-nummer	id	string	Fältets numeriska ID.
name	name	string	Namnet på det anpassade fältet.

Hämtar alla betalningar

Åtgärds-ID:: GetPayments

Hämtar alla betalningar, inklusive annullerade och betalda betalningar. Dessa kan filtreras med hjälp av frågeparametrarna.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Referenssträng för betalningen	reference_number		string	Användardefinierat ID definierat när betalningar skapas som kan användas för att snabbt hitta betalningar. Referensnummer är inte unika. många betalningar kan ha samma referens.
Telefonnummer för betalning	phone_number		string	Telefonnummer för den kontakt som betalningen skickades till.
Sortera efter	sort_type		string	Egenskap att sortera betalningar efter. Kan vara "amount", "contact", "date", "status".
Sorteringsriktning	sort_direction		string	Riktning för att sortera betalningar i. Kan vara "desc" för störst till minsta, eller "asc" för minsta till största.
Nummersida att hämta	page	True	integer	Sidan med entiteter som ska hämtas. När du hämtar värden finns det en maximal storlek per sida, definierad av page_size. Om sidan är större än den sista sidan returneras en tom matris.
Belopp för varje entitet som ska hämtas per sida	page_size	True	integer	Storleken på varje sida som ska hämtas. När du hämtar värden är detta en maximal storlek per sida, med åtkomst till efterföljande sidor som görs av sidparametern.
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.

Returer

Name	Sökväg	Typ	Description
sida	meta.page	integer	Sidan med entiteter som har tagits fram. Mängden entiteter på den här sidan definieras av page_size.
page_size	meta.page_size	integer	Antalet entiteter som finns på den här sidan.
total_items	meta.total_items	integer	Antalet entiteter som är tillgängliga i databasen, oavsett sidstorlek eller nummer. Om du vill se de andra sidorna ändrar du sidnumret i begäran.
items	items	array of object	Lista över betalningsentiteter som hämtats från textbegäran.
payment_id	items.payment_id	integer	Det numeriska ID:t för betalningen.
request_date	items.request_date	string	Tidsstämpeln för när den här betalningens första meddelande köades för att skickas.
mottagare	items.recipient	string	Namnet på betalningsmottagaren. Detta kan vara null om kontakten inte har något namn kopplat till sitt telefonnummer.
beskrivning	items.description	string	Beskrivning av betalningen. Detta visas inte för kontakten. Den används endast av interna användare för kontext om betalningar.
customer_phone	items.customer_phone	string	Telefonnumret till den kontakt som skickas den här betalningen.
amount_requested	items.amount_requested	float	Beloppet i dollar som begärs av den här betalningen.
is_past_due	items.is_past_due	boolean	Om den här betalningen har passerat begärandedatumet.
reminder_was_sent	items.reminder_was_sent	boolean	Om en textpåminnelse redan har skickats för den här betalningen.
transaction_status	items.transaction_status	string	Status för transaktionen i authvia. Det här värdet börjar som Okänt.
textrequest_payment_status	items.textrequest_payment_status	string	Status för transaktionen i textbegäran. Detta representerar den status som visas på betalningssidan i appen Textbegäran. Det börjar som Skickat.
reference_number	items.reference_number	string	Det användardefinierade ID som definieras när betalningar skapas som kan användas för att snabbt hitta betalningar. Referensnummer är inte unika. många betalningar kan ha samma referens.

Hämtar alla grupper

Åtgärds-ID:: GetGroups

Hämtar alla grupper för användarens konto.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Nummersida att hämta	page	True	integer	Sidan med entiteter som ska hämtas. När du hämtar värden finns det en maximal storlek per sida, definierad av page_size. Om sidan är större än den sista sidan returneras en tom matris.
Belopp för varje entitet som ska hämtas per sida	page_size	True	integer	Storleken på varje sida som ska hämtas. När du hämtar värden är detta en maximal storlek per sida, med åtkomst till efterföljande sidor som görs av sidparametern.
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.

Returer

Name	Sökväg	Typ	Description
sida	meta.page	integer	Sidan med entiteter som har tagits fram. Mängden entiteter på den här sidan definieras av page_size.
page_size	meta.page_size	integer	Antalet entiteter som finns på den här sidan.
total_items	meta.total_items	integer	Antalet entiteter som är tillgängliga i databasen, oavsett sidstorlek eller nummer. Om du vill se de andra sidorna ändrar du sidnumret i begäran.
items	items	array of object	Lista över gruppentiteter som hämtats från textbegäran.
Id-nummer	items.id	integer	Gruppens numeriska ID.
group_member_count	items.group_member_count	integer	Antalet medlemmar i gruppen.
is_keyword	items.is_keyword	boolean	Den här gruppen är en nyckelordsgrupp. Sådana grupper genereras automatiskt när en användare konfigurerar ett nyckelord. Kontakter läggs automatiskt till när de registreras.
name	items.name	string	Namnet på den här gruppen.
Anteckningar	items.notes	string	Eventuella anteckningar om den här gruppen.
last_message_sent_utc	items.last_message_sent_utc	string	Tidsstämpeln för när det senaste gruppmeddelandet skickades för den här gruppen.

Hämtar alla konversationer för den här instrumentpanelen

Åtgärds-ID:: GetConversations

Hämtar alla konversationer för den här instrumentpanelen och innehåller information om det sista meddelandet för varje konversation.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kontakttaggar	tags		string	Kommaavgränsad lista över guids som refererar till taggar för att filtrera konversationer efter.
Om du bara vill visa lösta konversationer	show_unresolved_only		string	Om du bara vill söka efter kontakter vars konversationer har lösts. Om detta är falskt visas både lösta och olösta konversationer.
Om arkiverade konversationer ska inkluderas	include_archived		string	Om du vill inkludera konversationer med kontakter som har arkiverats.
Term att filtrera efter för telefonnummer och kontaktnamn	search		string	Sökterm för att filtrera konversationer efter telefonnummer eller visningsnamn. Om söktermen är mindre än ett fullständigt namn eller telefonnummer returnerar sökningen alla konversationer som delvis matchar den.
Nummersida att hämta	page		integer	Sidan med entiteter som ska hämtas. När du hämtar värden finns det en maximal storlek per sida, definierad av page_size. Om sidan är större än den sista sidan returneras en tom matris.
Belopp för varje entitet som ska hämtas per sida	page_size		integer	Storleken på varje sida som ska hämtas. När du hämtar värden är detta en maximal storlek per sida, med åtkomst till efterföljande sidor som görs av sidparametern.
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.

Returer

Name	Sökväg	Typ	Description
sida	meta.page	integer	Sidan med entiteter som har tagits fram. Mängden entiteter på den här sidan definieras av page_size.
page_size	meta.page_size	integer	Antalet entiteter som finns på den här sidan.
total_items	meta.total_items	integer	Antalet entiteter som är tillgängliga i databasen, oavsett sidstorlek eller nummer. Om du vill se de andra sidorna ändrar du sidnumret i begäran.
items	items	array of object	Lista över konversationsentiteter som hämtats från textbegäran.
telefonnummer	items.phone_number	string	Kontaktens telefonnummer.
message_id	items.last_message.message_id	string	Id för meddelandet. Det här värdet är unikt för varje meddelande.
body	items.last_message.body	string	Innehållet i det här meddelandet.
message_direction	items.last_message.message_direction	string	Singulartecken, antingen R eller S, som anger om det här meddelandet togs emot från kontakten eller skickades till dem.
response_by_username	items.last_message.response_by_username	string	Användarnamn för den textbegärandeanvändare som senast skickade ett meddelande till den här användaren.
message_timestamp_utc	items.last_message.message_timestamp_utc	string	Tidsstämpel för när meddelandet skickades eller togs emot av textbegäran.
delivery_status	items.last_message.delivery_status	string	Aktuell status för det här meddelandet. Det kan vara "skicka", "levererad", "fel" eller "skicka".
delivery_error	items.last_message.delivery_error	string	Fel som gjorde att meddelandet inte levererades. Om delivery_status inte är "fel" är det här värdet null.
mms_media	items.last_message.mms_media	array of string	Lista över URL:er som pekar på det här meddelandets bifogade filer. Alla URL:er är textbegärandegenererade URL:er.

Hämtar alla taggar

Åtgärds-ID:: GetTags

Hämtar alla taggar för den här instrumentpanelen. Taggar är unika mellan instrumentpaneler.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.
Nummersida att hämta	page	True	integer	Sidan med entiteter som ska hämtas. När du hämtar värden finns det en maximal storlek per sida, definierad av page_size. Om sidan är större än den sista sidan returneras en tom matris.
Belopp för varje entitet som ska hämtas per sida	page_size	True	integer	Storleken på varje sida som ska hämtas. När du hämtar värden är detta en maximal storlek per sida, med åtkomst till efterföljande sidor som görs av sidparametern.

Returer

Name	Sökväg	Typ	Description
sida	meta.page	integer	Sidan med entiteter som har tagits fram. Mängden entiteter på den här sidan definieras av page_size.
page_size	meta.page_size	integer	Antalet entiteter som finns på den här sidan.
total_items	meta.total_items	integer	Antalet entiteter som är tillgängliga i databasen, oavsett sidstorlek eller nummer. Om du vill se de andra sidorna ändrar du sidnumret i begäran.
items	items	array of object	Lista över taggentiteter som hämtats från textbegäran.
Id-nummer	items.id	string	Taggens numeriska ID.
tag_color	items.tag_color	string	Färgen på taggen. Detta bör vara en giltig hexadecimal färgkod.
tag	items.tag	string	Namnet på taggen.

Hämtar betalningen med det angivna ID:t

Åtgärds-ID:: GetPayment

Hämtar betalningen med det angivna ID:t.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.
ID för betalningen	payment_id	True	integer	Det numeriska ID:t för betalningen som ska hämtas.

Returer

Name	Sökväg	Typ	Description
payment_id	payment_id	integer	Det numeriska ID:t för betalningen.
request_date	request_date	string	Tidsstämpeln för när den här betalningens första meddelande köades för att skickas.
mottagare	recipient	string	Namnet på betalningsmottagaren. Detta kan vara null om kontakten inte har något namn kopplat till sitt telefonnummer.
beskrivning	description	string	Beskrivning av betalningen. Detta visas inte för kontakten. Den används endast av interna användare för kontext om betalningar.
customer_phone	customer_phone	string	Telefonnumret till den kontakt som skickas den här betalningen.
amount_requested	amount_requested	float	Beloppet i dollar som begärs av den här betalningen.
is_past_due	is_past_due	boolean	Om den här betalningen har passerat begärandedatumet.
reminder_was_sent	reminder_was_sent	boolean	Om en textpåminnelse redan har skickats för den här betalningen.
transaction_status	transaction_status	string	Status för transaktionen i authvia. Det här värdet börjar som Okänt.
textrequest_payment_status	textrequest_payment_status	string	Status för transaktionen i textbegäran. Detta representerar den status som visas på betalningssidan i appen Textbegäran. Det börjar som Skickat.
reference_number	reference_number	string	Det användardefinierade ID som definieras när betalningar skapas som kan användas för att snabbt hitta betalningar. Referensnummer är inte unika. många betalningar kan ha samma referens.

Hämtar kontakten med det angivna telefonnumret

Åtgärds-ID:: GetContactByPhoneNumber

Hämtar kontakten med det angivna telefonnumret

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.
Telefonnummer för kontakten	phone_number	True	string	Telefonnummer för den kontakt som ska hämtas.

Returer

Name	Sökväg	Typ	Description
telefonnummer	phone_number	string	Telefonnummer för den här kontakten.
first_name	first_name	string	Förnamn för den här kontakten.
last_name	last_name	string	Efternamn på den här kontakten.
display_name	display_name	string	Fullständigt namn på den här kontakten. Det här är standardnamnet som visas i webbappen när kontakter visas.
is_suppressed	is_suppressed	boolean	Om konversationen med den här kontakten ignoreras och därför inte skickas överst i meddelandekön när den tas emot.
is_archived	is_archived	boolean	Om konversationen med den här kontakten arkiveras och därför inte kan visas vid frågor mot konversationer (som standard).
is_blocked	is_blocked	boolean	Om konversationen med den här kontakten blockeras och därför inte tas emot eller lagras.
suppressed_reason	suppressed_reason	string	Fras som beskriver orsaken till att kontakten inte används. Om is_suppressed är falskt blir det null.
not	note	string	Kort fras som beskriver kontakt. Används för enkelhetens skull. Detta visas aldrig för kontakten.
groups	groups	array of integer	Matris med heltals-ID:t som refererar till grupper som kontakten tillhör.
contact_tags	contact_tags	array of string	Matris med guids som refererar till taggar som är kopplade till den här kontakten.
custom_fields	custom_fields	array of object	Matris med anpassade fält-ID:er och värden som definierats för den här kontakten.
Id-nummer	custom_fields.id	string	Guid som refererar till ett anpassat fält.
värde	custom_fields.value	string	Den här kontaktens värde för det här anpassade fältet.
is_resolved	is_resolved	boolean	Om konversationen med den här kontakten är löst. Alla nya texter som tas emot av denna kontakt kommer att ange detta falskt.
first_contact_utc	first_contact_utc	string	Tidsstämpel för när det första meddelandet skickades till den här kontakten.
opted_out_utc	opted_out_utc	string	Tidsstämpel för när den här kontakten valde att ta emot meddelanden.
last_msg_sent_utc	last_msg_sent_utc	string	Tidsstämpel för när det senaste meddelandet skickades till den här kontakten.
last_msg_received_utc	last_msg_received_utc	string	Tidsstämpel för när det senaste meddelandet togs emot från den här kontakten.
total_msgs_sent	total_msgs_sent	integer	Antalet meddelanden som skickats till den här kontakten.
total_msgs_received	total_msgs_received	integer	Antalet totalt antal meddelanden som tagits emot från den här kontakten.
response_count	response_count	integer	Det totala antalet svarsmeddelanden från kontakten.
date_created_utc	date_created_utc	string	Tidsstämpeln för när kontakterna skapades.
last_contact_date_utc	last_contact_date_utc	string	Tidsstämpeln för när det senaste meddelandet skickades eller togs emot från den här kontakten.
message_id	last_message.message_id	string	Id för meddelandet. Det här värdet är unikt för varje meddelande.
body	last_message.body	string	Innehållet i det här meddelandet.
message_direction	last_message.message_direction	string	Singulartecken, antingen R eller S, som anger om det här meddelandet togs emot från kontakten eller skickades till dem.
response_by_username	last_message.response_by_username	string	Användarnamn för den textbegärandeanvändare som senast skickade ett meddelande till den här användaren.
message_timestamp_utc	last_message.message_timestamp_utc	string	Tidsstämpel för när meddelandet skickades eller togs emot av textbegäran.
delivery_status	last_message.delivery_status	string	Aktuell status för det här meddelandet. Det kan vara "skicka", "levererad", "fel" eller "skicka".
delivery_error	last_message.delivery_error	string	Fel som gjorde att meddelandet inte levererades. Om delivery_status inte är "fel" är det här värdet null.
mms_media	last_message.mms_media	array of string	Lista över URL:er som pekar på det här meddelandets bifogade filer. Alla URL:er är textbegärandegenererade URL:er.

Markera en betalning som betald

Åtgärds-ID:: MarkPaymentPaid

Stänger en betalning som "betald". Använd den här slutpunkten för när betalningen betalas via ett annat sätt än portalen för betalningsbegäran. Då stängs betalningen och dess betalningsbelopp läggs till i din statistik. Den här slutpunkten krävs inte för betalningar som betalas via betalningsportalen som skickas via textbegäran. som automatiskt markerar en betalning som betald.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.
ID för betalningen	payment_id	True	integer	Det numeriska ID:t för betalningen som ska uppdateras.

Returer

Name	Sökväg	Typ	Description
payment_id	payment_id	integer	Det numeriska ID:t för betalningen.
request_date	request_date	string	Tidsstämpeln för när den här betalningens första meddelande köades för att skickas.
mottagare	recipient	string	Namnet på betalningsmottagaren. Detta kan vara null om kontakten inte har något namn kopplat till sitt telefonnummer.
beskrivning	description	string	Beskrivning av betalningen. Detta visas inte för kontakten. Den används endast av interna användare för kontext om betalningar.
customer_phone	customer_phone	string	Telefonnumret till den kontakt som skickas den här betalningen.
amount_requested	amount_requested	float	Beloppet i dollar som begärs av den här betalningen.
is_past_due	is_past_due	boolean	Om den här betalningen har passerat begärandedatumet.
reminder_was_sent	reminder_was_sent	boolean	Om en textpåminnelse redan har skickats för den här betalningen.
transaction_status	transaction_status	string	Status för transaktionen i authvia. Det här värdet börjar som Okänt.
textrequest_payment_status	textrequest_payment_status	string	Status för transaktionen i textbegäran. Detta representerar den status som visas på betalningssidan i appen Textbegäran. Det börjar som Skickat.
reference_number	reference_number	string	Det användardefinierade ID som definieras när betalningar skapas som kan användas för att snabbt hitta betalningar. Referensnummer är inte unika. många betalningar kan ha samma referens.

Massuppdateringskontakter

Åtgärds-ID:: BulkUpdateContacts

Endast den angivna instrumentpanelen har kontakter tillagda. kontakter ordnas efter instrumentpanel och det finns ingen sökning på kontonivå efter ett tal tillgängligt.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.
Telefonnummer för kontakt	phone_number		string	Telefonnummer för kontakten som ska skapas eller uppdateras.
Förnamn på kontakt	first_name		string	Kontaktens nya förnamn.
Efternamn på kontakt	last_name		string	Kontaktens nya efternamn.
Fullständigt namn på kontakt	display_name		string	Det nya fullständiga namnet på kontakten. Det här är standardnamnet som visas i webbappen när kontakter visas.
Om meddelanden från den här kontakten ignoreras	is_suppressed		boolean	Avgör om konversationer med den här kontakten ignoreras och därför inte skickas överst i meddelandekön när de tas emot.
Om meddelanden från den här kontakten arkiveras	is_archived		boolean	Avgör om konversationer med den här kontakten arkiveras och kan därför inte visas när du kör frågor mot konversationer (som standard).
Om meddelanden från den här kontakten blockeras	is_blocked		boolean	Avgör om konversationer med den här kontakten blockeras och därför inte tas emot eller lagras.
Orsak till att den här kontakten utelämnas	suppressed_reason		string	Fras som beskriver orsaken till att kontakten inte används.
Kontaktanteckning	note		string	Kort fras som beskriver kontakt. Används för enkelhetens skull. Detta visas aldrig för kontakten.
Kontaktgrupper	groups		array of integer	Matris med heltals-ID:t som refererar till grupper som den här kontakten tillhör.
Kontakttaggar	contact_tags		array of string	Matris med guids som refererar till taggar som är kopplade till den här kontakten.
Anpassat fält-ID	id		string	Guid som refererar till ett anpassat fält.
Värde för anpassat fält	value		string	Den här kontaktens värde för det här anpassade fältet.
Om den aktuella konversationen med den här kontakten har lösts	is_resolved		boolean	Avgör om den aktuella konversationen med den här kontakten har lösts. Alla nya texter som tas emot av denna kontakt kommer att ange detta falskt.

Returer

Name	Sökväg	Typ	Description
		array of object
telefonnummer	phone_number	string	Telefonnummer för den här kontakten.
first_name	first_name	string	Förnamn för den här kontakten.
last_name	last_name	string	Efternamn på den här kontakten.
display_name	display_name	string	Fullständigt namn på den här kontakten. Det här är standardnamnet som visas i webbappen när kontakter visas.
is_suppressed	is_suppressed	boolean	Om konversationen med den här kontakten ignoreras och därför inte skickas överst i meddelandekön när den tas emot.
is_archived	is_archived	boolean	Om konversationen med den här kontakten arkiveras och därför inte kan visas vid frågor mot konversationer (som standard).
is_blocked	is_blocked	boolean	Om konversationen med den här kontakten blockeras och därför inte tas emot eller lagras.
suppressed_reason	suppressed_reason	string	Fras som beskriver orsaken till att kontakten inte används. Om is_suppressed är falskt blir det null.
not	note	string	Kort fras som beskriver kontakt. Används för enkelhetens skull. Detta visas aldrig för kontakten.
groups	groups	array of integer	Matris med heltals-ID:t som refererar till grupper som kontakten tillhör.
contact_tags	contact_tags	array of string	Matris med guids som refererar till taggar som är kopplade till den här kontakten.
custom_fields	custom_fields	array of object	Matris med anpassade fält-ID:er och värden som definierats för den här kontakten.
Id-nummer	custom_fields.id	string	Guid som refererar till ett anpassat fält.
värde	custom_fields.value	string	Den här kontaktens värde för det här anpassade fältet.
is_resolved	is_resolved	boolean	Om konversationen med den här kontakten är löst. Alla nya texter som tas emot av denna kontakt kommer att ange detta falskt.
first_contact_utc	first_contact_utc	string	Tidsstämpel för när det första meddelandet skickades till den här kontakten.
opted_out_utc	opted_out_utc	string	Tidsstämpel för när den här kontakten valde att ta emot meddelanden.
last_msg_sent_utc	last_msg_sent_utc	string	Tidsstämpel för när det senaste meddelandet skickades till den här kontakten.
last_msg_received_utc	last_msg_received_utc	string	Tidsstämpel för när det senaste meddelandet togs emot från den här kontakten.
total_msgs_sent	total_msgs_sent	integer	Antalet meddelanden som skickats till den här kontakten.
total_msgs_received	total_msgs_received	integer	Antalet totalt antal meddelanden som tagits emot från den här kontakten.
response_count	response_count	integer	Totalt antal svarsmeddelanden från kontakten.
date_created_utc	date_created_utc	string	Tidsstämpel för när kontakterna skapades.
last_contact_date_utc	last_contact_date_utc	string	Tidsstämpel för när det senaste meddelandet skickades eller togs emot från den här kontakten.
message_id	last_message.message_id	string	Id för meddelandet. Det här värdet är unikt för varje meddelande.
body	last_message.body	string	Innehållet i det här meddelandet.
message_direction	last_message.message_direction	string	Singulartecken, antingen R eller S, som anger om det här meddelandet togs emot från kontakten eller skickades till dem.
response_by_username	last_message.response_by_username	string	Användarnamn för den textbegärandeanvändare som senast skickade ett meddelande till den här användaren.
message_timestamp_utc	last_message.message_timestamp_utc	string	Tidsstämpel för när meddelandet skickades eller togs emot av textbegäran.
delivery_status	last_message.delivery_status	string	Aktuell status för det här meddelandet. Det kan vara "skicka", "levererad", "fel" eller "skicka".
delivery_error	last_message.delivery_error	string	Fel som gjorde att meddelandet inte levererades. Om delivery_status inte är "fel" är det här värdet null.
mms_media	last_message.mms_media	array of string	Lista över URL:er som pekar på det här meddelandets bifogade filer. Alla URL:er är textbegärandegenererade URL:er.

Skapa eller uppdatera en kontakt

Åtgärds-ID:: CreateContact

Skapar eller uppdaterar en kontakt (beroende på om det redan finns en kontakt med det angivna telefonnumret).

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.
Telefonnummer för kontakt	phone_number	True	string	Telefonnummer för kontakten som ska skapas eller uppdateras.
Förnamn på kontakt	first_name		string	Kontaktens nya förnamn.
Efternamn på kontakt	last_name		string	Kontaktens nya efternamn.
Fullständigt namn på kontakt	display_name		string	Det nya fullständiga namnet på kontakten. Det här är standardnamnet som visas i webbappen när kontakter visas.
Om meddelanden från den här kontakten ignoreras	is_suppressed		boolean	Avgör om konversationer med den här kontakten ignoreras och därför inte skickas överst i meddelandekön när de tas emot.
Om meddelanden från den här kontakten arkiveras	is_archived		boolean	Avgör om konversationer med den här kontakten arkiveras och kan därför inte visas när du kör frågor mot konversationer (som standard).
Om meddelanden från den här kontakten blockeras	is_blocked		boolean	Avgör om konversationer med den här kontakten blockeras och därför inte tas emot eller lagras.
Orsak till att den här kontakten utelämnas	suppressed_reason		string	Fras som beskriver orsaken till att kontakten inte används.
Kontaktanteckning	note		string	Kort fras som beskriver kontakt. Används för enkelhetens skull. Detta visas aldrig för kontakten.
Kontaktgrupper	groups		array of integer	Matris med heltals-ID:t som refererar till grupper som den här kontakten tillhör.
Kontakttaggar	contact_tags		array of string	Matris med guids som refererar till taggar som är kopplade till den här kontakten.
Anpassat fält-ID	id		string	Guid som refererar till ett anpassat fält.
Värde för anpassat fält	value		string	Den här kontaktens värde för det här anpassade fältet.
Om den aktuella konversationen med den här kontakten har lösts	is_resolved		boolean	Avgör om den aktuella konversationen med den här kontakten har lösts. Alla nya texter som tas emot av denna kontakt kommer att ange detta falskt.

Returer

Name	Sökväg	Typ	Description
telefonnummer	phone_number	string	Telefonnummer för den här kontakten.
first_name	first_name	string	Förnamn för den här kontakten.
last_name	last_name	string	Efternamn på den här kontakten.
display_name	display_name	string	Fullständigt namn på den här kontakten. Det här är standardnamnet som visas i webbappen när kontakter visas.
is_suppressed	is_suppressed	boolean	Om konversationen med den här kontakten ignoreras och därför inte skickas överst i meddelandekön när den tas emot.
is_archived	is_archived	boolean	Om konversationen med den här kontakten arkiveras och därför inte kan visas vid frågor mot konversationer (som standard).
is_blocked	is_blocked	boolean	Om konversationen med den här kontakten blockeras och därför inte tas emot eller lagras.
suppressed_reason	suppressed_reason	string	Fras som beskriver orsaken till att kontakten inte används. Om is_suppressed är falskt blir det null.
not	note	string	Kort fras som beskriver kontakt. Används för enkelhetens skull. Detta visas aldrig för kontakten.
groups	groups	array of integer	Matris med heltals-ID:t som refererar till grupper som kontakten tillhör.
contact_tags	contact_tags	array of string	Matris med guids som refererar till taggar som är kopplade till den här kontakten.
custom_fields	custom_fields	array of object	Matris med anpassade fält-ID:er och värden som definierats för den här kontakten.
Id-nummer	custom_fields.id	string	Guid som refererar till ett anpassat fält.
värde	custom_fields.value	string	Den här kontaktens värde för det här anpassade fältet.
is_resolved	is_resolved	boolean	Om konversationen med den här kontakten är löst. Alla nya texter som tas emot av denna kontakt kommer att ange detta falskt.
first_contact_utc	first_contact_utc	string	Tidsstämpel för när det första meddelandet skickades till den här kontakten.
opted_out_utc	opted_out_utc	string	Tidsstämpel för när den här kontakten valde att ta emot meddelanden.
last_msg_sent_utc	last_msg_sent_utc	string	Tidsstämpel för när det senaste meddelandet skickades till den här kontakten.
last_msg_received_utc	last_msg_received_utc	string	Tidsstämpel för när det senaste meddelandet togs emot från den här kontakten.
total_msgs_sent	total_msgs_sent	integer	Antalet meddelanden som skickats till den här kontakten.
total_msgs_received	total_msgs_received	integer	Antalet totalt antal meddelanden som tagits emot från den här kontakten.
response_count	response_count	integer	Totalt antal svarsmeddelanden från kontakten.
date_created_utc	date_created_utc	string	Tidsstämpel för när kontakterna skapades.
last_contact_date_utc	last_contact_date_utc	string	Tidsstämpel för när det senaste meddelandet skickades eller togs emot från den här kontakten.
message_id	last_message.message_id	string	Id för meddelandet. Det här värdet är unikt för varje meddelande.
body	last_message.body	string	Innehållet i det här meddelandet.
message_direction	last_message.message_direction	string	Singulartecken, antingen R eller S, som anger om det här meddelandet togs emot från kontakten eller skickades till dem.
response_by_username	last_message.response_by_username	string	Användarnamn för den textbegärandeanvändare som senast skickade ett meddelande till den här användaren.
message_timestamp_utc	last_message.message_timestamp_utc	string	Tidsstämpel för när meddelandet skickades eller togs emot av textbegäran.
delivery_status	last_message.delivery_status	string	Aktuell status för det här meddelandet. Det kan vara "skicka", "levererad", "fel" eller "skicka".
delivery_error	last_message.delivery_error	string	Fel som gjorde att meddelandet inte levererades. Om delivery_status inte är "fel" är det här värdet null.
mms_media	last_message.mms_media	array of string	Lista över URL:er som pekar på det här meddelandets bifogade filer. Alla URL:er är textbegärandegenererade URL:er.

Skapa en ny instrumentpanel med förnamn och telefonnummer

Åtgärds-ID:: CreateDashboard

Skapar en ny instrumentpanel i kontot. När instrumentpanelen har skapats får administratörer ett e-postmeddelande om ändringen och kan börja tilldela användare. Den här slutpunkten kan skapa en instrumentpanel för alla etablerade tal. Du kan söka efter etablerade nummer i en specifik riktnummer med get /dashboards/provisioning. Om telefonnumret redan används utlöses ett undantag för felaktig begäran.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
name	name		string	Namnet på instrumentpanelen.
phone	phone		string	Textnumret som är associerat med den här instrumentpanelen.

Returer

Name	Sökväg	Typ	Description
Id-nummer	id	integer	Instrumentpanelens numeriska ID.
name	name	string	Namnet på instrumentpanelen.
phone	phone	string	Textnumret som är associerat med den här instrumentpanelen.

Skapar en ny betalning

Åtgärds-ID:: CreatePayment

Skapar en ny betalning med det angivna meddelandet till den angivna kontakten.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.
Betalningsbeskrivning	description		string	Beskrivning av betalningen. Beskrivningen visas inte för kontakten och används endast av interna användare för kontext om betalningar.
Telefonnummer för mottagare	customer_phone		string	Telefonnummer för den kontakt som betalningen skickas till.
Begärt belopp i dollar	amount_requested		float	Beloppet i dollar som begärs av den här betalningen.
Texttexttext för betalningsmeddelande	message		string	Meddelandetext som ska skickas till kontakt tillsammans med betalningslänken.
Referenssträng för betalningen	reference_number		string	Användardefinierat ID definierat när betalningar skapas som kan användas för att snabbt hitta betalningar. Referensnummer är inte unika. många betalningar kan ha samma referens.

Returer

Name	Sökväg	Typ	Description
payment_id	payment_id	integer	Det numeriska ID:t för betalningen.
request_date	request_date	string	Tidsstämpeln för när den här betalningens första meddelande köades för att skickas.
mottagare	recipient	string	Namnet på betalningsmottagaren. Detta kan vara null om kontakten inte har något namn kopplat till sitt telefonnummer.
beskrivning	description	string	Beskrivning av betalningen. Detta visas inte för kontakten. Den används endast av interna användare för kontext om betalningar.
customer_phone	customer_phone	string	Telefonnumret till den kontakt som skickas den här betalningen.
amount_requested	amount_requested	float	Beloppet i dollar som begärs av den här betalningen.
is_past_due	is_past_due	boolean	Om den här betalningen har passerat begärandedatumet.
reminder_was_sent	reminder_was_sent	boolean	Om en textpåminnelse redan har skickats för den här betalningen.
transaction_status	transaction_status	string	Status för transaktionen i authvia. Det här värdet börjar som Okänt.
textrequest_payment_status	textrequest_payment_status	string	Status för transaktionen i textbegäran. Detta representerar den status som visas på betalningssidan i appen Textbegäran. Det börjar som Skickat.
reference_number	reference_number	string	Det användardefinierade ID som definieras när betalningar skapas som kan användas för att snabbt hitta betalningar. Referensnummer är inte unika. många betalningar kan ha samma referens.

Skapar en ny grupp

Åtgärds-ID:: CreateGroup

Skapar en ny grupp med det angivna namnet.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.
Gruppnamn	name		string	Det nya namnet på gruppen.
Gruppanteckning	notes		string	Kort fras som beskriver grupp. Används för enkelhetens skull.

Returer

Name	Sökväg	Typ	Description
Id-nummer	id	integer	Gruppens numeriska ID.
group_member_count	group_member_count	integer	Antalet medlemmar i gruppen.
is_keyword	is_keyword	boolean	Den här gruppen är en nyckelordsgrupp. Sådana grupper genereras automatiskt när en användare konfigurerar ett nyckelord. Kontakter läggs automatiskt till när de registreras.
name	name	string	Namnet på den här gruppen.
Anteckningar	notes	string	Eventuella anteckningar om den här gruppen.
last_message_sent_utc	last_message_sent_utc	string	Tidsstämpel för när det senaste gruppmeddelandet skickades för den här gruppen.

Skicka en uppföljningstext som påminner användaren om att betala den angivna betalningen

Åtgärds-ID:: SendPaymentReminder

Skickar en påminnelse till kontakten om att betala den angivna betalningen. Innehållet i meddelandet genereras automatiskt. För att undvika skräppost kan bara en påminnelse skickas per betalning

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.
ID för betalningen	payment_id	True	integer	Det numeriska ID:t för betalningen som ska uppdateras.

Returer

Name	Sökväg	Typ	Description
payment_id	payment_id	integer	Det numeriska ID:t för betalningen.
request_date	request_date	string	Tidsstämpeln för när den här betalningens första meddelande köades för att skickas.
mottagare	recipient	string	Namnet på betalningsmottagaren. Detta kan vara null om kontakten inte har något namn kopplat till sitt telefonnummer.
beskrivning	description	string	Beskrivning av betalningen. Detta visas inte för kontakten. Den används endast av interna användare för kontext om betalningar.
customer_phone	customer_phone	string	Telefonnumret till den kontakt som skickas den här betalningen.
amount_requested	amount_requested	float	Beloppet i dollar som begärs av den här betalningen.
is_past_due	is_past_due	boolean	Om den här betalningen har passerat begärandedatumet.
reminder_was_sent	reminder_was_sent	boolean	Om en textpåminnelse redan har skickats för den här betalningen.
transaction_status	transaction_status	string	Status för transaktionen i authvia. Det här värdet börjar som Okänt.
textrequest_payment_status	textrequest_payment_status	string	Status för transaktionen i textbegäran. Detta representerar den status som visas på betalningssidan i appen Textbegäran. Det börjar som Skickat.
reference_number	reference_number	string	Det användardefinierade ID som definieras när betalningar skapas som kan användas för att snabbt hitta betalningar. Referensnummer är inte unika. många betalningar kan ha samma referens.

Skicka ett meddelande till kontakten med det angivna telefonnumret

Åtgärds-ID:: SendMessageByPhoneNumber

Skickar ett meddelande (startar en ny konversation om det angivna telefonnumret inte har någon meddelandehistorik).

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.
Telefonnummer till meddelande	phone_number	True	string	Telefonnummer för kontakten som du vill skicka ett meddelande till.
Meddelandetext	body		string	Innehållet i meddelandet som ska skickas.
Avsändarens namn	sender_name		string	Namnet på meddelandesändaren. Detta visas i TextRequest-webbappen och API:et när du hämtar det här meddelandet.
Återanrops-URL för när meddelandestatusen uppdateras	status_callback		string	Url för webbappen att träffa med ett POST-kommando när meddelandets status går från olevererad till skickad (eller fel).
Återanrops-URL för platsbegäranden om det här meddelandet innehåller en	location_callback		string	Platsåteranrops-URL för att träffa med ett POST-kommando när användaren kommer åt och godkänner delning av sin plats med avsändaren. Om du vill inkludera länken lägger du till [Platsbegäran] i meddelandetexten. Det här återanropet krävs inte för platsbegäranden, men det kan vara användbart för API:er.
MMS Media-bifogade filer för det här meddelandet	mms_media		array of string	Matris med MMS Media-bifogade filer för det här meddelandet. Bifogade filer måste vara url:ar som hämtats från post /mms-slutpunkten (ingår inte i den här anslutningsappen). Länkar till externa bifogade filer accepteras inte.

Returer

Name	Sökväg	Typ	Description
message_id	message_id	string	Id för meddelandet. Det här värdet är unikt för varje meddelande.
body	body	string	Innehållet i det här meddelandet.
message_direction	message_direction	string	Singulartecken, antingen R eller S, som anger om det här meddelandet togs emot från kontakten eller skickades till dem.
response_by_username	response_by_username	string	Användarnamn för den textbegärandeanvändare som senast skickade ett meddelande till den här användaren.
message_timestamp_utc	message_timestamp_utc	string	Tidsstämpel för när meddelandet skickades eller togs emot av textbegäran.
delivery_status	delivery_status	string	Aktuell status för det här meddelandet. Det kan vara "skicka", "levererad", "fel" eller "skicka".
delivery_error	delivery_error	string	Fel som gjorde att meddelandet inte levererades. Om delivery_status inte är "fel" är det här värdet null.
mms_media	mms_media	array of string	Lista över URL:er som pekar på det här meddelandets bifogade filer. Alla URL:er är textbegärandegenererade URL:er.

Tar bort den angivna instrumentpanelen

Åtgärds-ID:: DeleteDashboard

Tar bort den angivna instrumentpanelen.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.

Returer

response: string

Tar bort gruppen med det angivna ID:t

Åtgärds-ID:: DeleteGroup

Tar bort gruppen med det angivna ID:t. Detta lyckas även om det finns kontakter som är medlemmar i gruppen (kontakterna tas inte bort).

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.
ID för gruppen	group_id	True	integer	Det numeriska ID för gruppen som ska tas bort.

Returer

response: string

Tar bort kontakten med det angivna telefonnumret

Åtgärds-ID:: DeleteContact

Tar bort kontakten med det angivna telefonnumret

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.
Telefonnummer för kontakt	phone_number	True	string	Telefonnummer för kontakten som ska tas bort.

Returer

response: string

Unarchive a Conversation

Åtgärds-ID:: UnarchiveConversation

Unarchives en konversation. När en konversation har tagits bort visas den återigen i kön. Den visas också i konversationer som returneras av slutpunkten /conversations. Om en konversation redan är oarchiverad har den här metoden ingen effekt.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.
Telefonnummer för konversation	phone_number	True	string	Telefonnumret för konversationen som ska arkiveras.

Returer

response: string

Uppdatera en specifik instrumentpanels namn

Åtgärds-ID:: UpdateDashboardsName

Uppdaterar en instrumentpanel. Detta ändrar inte en instrumentpanels telefonnummer. Om du vill ha ett nytt nummer med en annan instrumentpanels kontakter måste du skapa en ny instrumentpanel med en POST och lägga till kontakterna med en massexport/import.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.
Instrumentpanelens namn	name		string	Instrumentpanelens nya namn.

Returer

Name	Sökväg	Typ	Description
Id-nummer	id	integer	Instrumentpanelens numeriska ID.
name	name	string	Namnet på instrumentpanelen.
phone	phone	string	Textnumret som är associerat med den här instrumentpanelen.

Uppdaterar en grupp med det angivna ID:t

Åtgärds-ID:: UpdateGroup

Uppdaterar en grupps namn med hjälp av gruppens numeriska ID. Om det skickade grupp-ID:t inte finns misslyckas anropet.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID för instrumentpanelen för att göra det här anropet på	dashboard_id	True	integer	Instrumentpanelen för telefonnummer att arbeta med. Ett enda konto kan ha flera instrumentpaneler som representerar olika telefonlinjer för kunder.
ID för gruppen	group_id	True	integer	Det numeriska ID för gruppen som ska uppdateras.
Gruppnamn	name		string	Det nya namnet på gruppen.
Gruppanteckning	notes		string	Kort fras som beskriver grupp. Används för enkelhetens skull.

Returer

Name	Sökväg	Typ	Description
Id-nummer	id	integer	Gruppens numeriska ID.
group_member_count	group_member_count	integer	Antalet medlemmar i gruppen.
is_keyword	is_keyword	boolean	Den här gruppen är en nyckelordsgrupp. Sådana grupper genereras automatiskt när en användare konfigurerar ett nyckelord. Kontakter läggs automatiskt till när de registreras.
name	name	string	Namnet på den här gruppen.
Anteckningar	notes	string	Eventuella anteckningar om den här gruppen.
last_message_sent_utc	last_message_sent_utc	string	Tidsstämpel för när det senaste gruppmeddelandet skickades för den här gruppen.

Utlösare

Utlöses när en text skickas eller tas emot

Åtgärds-ID:: TextingWebhook

Utlöses när en text skickas eller tas emot

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Instrumentpanelen som utlösaren lyssnar på händelser från	dashboard_id	True	string	ID för instrumentpanelen för att lägga till utlösare i
händelse	event	True	string	händelse

Returer

Name	Sökväg	Typ	Description
Unikt meddelande-ID	messageUniqueIdentifier	string	messageUniqueIdentifier
Konto-ID	account.id	integer	Id-nummer
Konversations-ID	yourPhoneNumber.id	integer	Id-nummer
Instrumentpanelsnamn	yourPhoneNumber.description	string	beskrivning
Telefonnummer för instrumentpanel	yourPhoneNumber.phoneNumber	string	telefonnummer
Instrumentpanels-ID	conversation.id	integer	Id-nummer
date	conversation.date	string	date
Telefonnummer för kontakt	conversation.consumerPhoneNumber	string	consumerPhoneNumber
messageDirection	conversation.messageDirection	string	messageDirection
meddelande	conversation.message	string	meddelande
numSegments	conversation.numSegments	integer	numSegments
status	conversation.status	string	status
Konversation som hävdas av	conversation.claimedBy	string	claimedBy
Kontaktvisningsnamn	conversation.consumerFriendlyName	string	consumerFriendlyName

Definitioner

snöre

Det här är den grundläggande datatypen "string".

Dela via

Textbegäran

Aranda Service Management Suite (ASMS)

Pre-requisites

Hämta autentiseringsuppgifter

Kom igång med anslutningsappen

Lyckat svar

Vanliga fel och åtgärder

Vanliga frågor

Skapa en anslutning

Standard

Begränsningsgränser

Åtgärder

Arkivera en konversation

Parametrar

Returer

Avbryter den angivna betalningen

Parametrar

Returer

Hämta alla instrumentpaneler i ett konto

Parametrar

Returer

Hämta alla kontakter som matchar det angivna filtreringskriteriet

Parametrar

Returer

Hämta en grupp efter dess ID

Parametrar

Returer

Hämta en konversations meddelanden via en kontakts telefonnummer

Parametrar

Returer

Hämta information på den här specifika instrumentpanelen

Parametrar

Returer

Hämtar alla anpassade fält

Parametrar

Returer

Hämtar alla betalningar

Parametrar

Returer

Hämtar alla grupper

Parametrar

Returer

Hämtar alla konversationer för den här instrumentpanelen

Parametrar

Returer

Hämtar alla taggar

Parametrar

Returer

Hämtar betalningen med det angivna ID:t

Parametrar

Returer

Hämtar kontakten med det angivna telefonnumret

Parametrar

Returer

Markera en betalning som betald

Parametrar

Returer

Massuppdateringskontakter

Parametrar

Returer

Skapa eller uppdatera en kontakt

Parametrar

Returer

Skapa en ny instrumentpanel med förnamn och telefonnummer

Parametrar

Returer

Skapar en ny betalning

Parametrar

Returer

Skapar en ny grupp

Parametrar

Returer

Skicka en uppföljningstext som påminner användaren om att betala den angivna betalningen

Parametrar

Returer

Skicka ett meddelande till kontakten med det angivna telefonnumret

Parametrar

Returer

Tar bort den angivna instrumentpanelen