다음을 통해 공유

텍스트 요청

텍스트 요청은 고객 참여를 촉발하기 위해 빌드된 비즈니스 문자 메시지 플랫폼입니다. 일상적인 통신 문제에 대한 플러그 앤 플레이 메시징 솔루션을 만들었으므로 소음을 줄이고 언제 어디서나 고객과 연결할 수 있습니다. 여러분과 같은 바쁜 비즈니스 리더를 돕는 방법에 대해 자세히 알아보세요.

이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.

서비스 클래스 Regions
Copilot Studio Premium 다음을 제외한 모든 Power Automate 지역 :
     - 미국 정부(GCC)
     - 미국 정부(GCC High)
     - 21Vianet에서 운영하는 중국 클라우드
     - 미국 국방부(DoD)
논리 앱 스탠다드 다음을 제외한 모든 Logic Apps 지역 :
     - Azure Government 지역
     - Azure 중국 지역
     - 미국 국방부(DoD)
Power Apps Premium 다음을 제외한 모든 Power Apps 지역 :
     - 미국 정부(GCC)
     - 미국 정부(GCC High)
     - 21Vianet에서 운영하는 중국 클라우드
     - 미국 국방부(DoD)
Power Automate Premium 다음을 제외한 모든 Power Automate 지역 :
     - 미국 정부(GCC)
     - 미국 정부(GCC High)
     - 21Vianet에서 운영하는 중국 클라우드
     - 미국 국방부(DoD)
연락처
이름 텍스트 요청 API 지원
URL https://www.textrequest.com/contact
전자 메일 apidev@textrequest.com
커넥터 메타데이터
게시자 텍스트 요청
웹 사이트 https://www.textrequest.com/
개인 정보 보호 정책 https://www.textrequest.com/privacy-policy/
카테고리 통신; 판매 및 CRM

ASMS(Aranda Service Management Suite)

비즈니스 프로세스 및 서비스를 관리, 통합 및 자동화할 수 있는 다중 테넌트 솔루션인 Aranda Service Management Suite를 사용하여 회사의 생산성을 높이고 사용자 환경을 혁신합니다. 인시던트, 요구 사항 및 변경 내용을 포함하여 ASMS의 모든 작업 영역(프로젝트)에 저장된 레코드를 만들고, 검색하고, 업데이트합니다.

Pre-requisites

계속하려면 다음 필수 구성 요소를 유의하세요.

  • ASMS(Aranda Service Management Suite)의 구독 및 인스턴스입니다. 여기에서 시작합니다. https://arandasoft.com/
  • 프리미엄 커넥터 기능이 있는 활성 Microsoft Power Automate 구독

자격 증명 가져오기

  • 인증을 수행하려면 통합 토큰을 사용합니다. 다음 링크에서 통합 토큰을 가져오는 방법에 대한 정보를 찾을 수 있습니다.

커넥터 시작

  1. ASMS(Aranda Service Management Suite)에 대한 구독이 필요합니다.

  2. 통합 토큰 가져오기

  3. ApiAsms(Aranda Service Management ASMS API)의 인스턴스 URL을 가져옵니다.

  4. Aranda Service Management Suite 커넥터와의 연결을 설정합니다.

  5. 커넥터에서 제공하는 다음 함수 중 하나를 선택합니다.

    표

  6. 커넥터에 대한 자세한 설명서는 를 참조하세요. https://docs.arandasoft.com/connectors

다음과 같은 경우에 이 커넥터를 사용할 수 있습니다.

  1. 사용 가능한 다른 작업 중에서 티켓을 만들고, 검색하고, 업데이트합니다.
  2. 티켓 추적 가능성을 가져옵니다.
  3. 티켓과 관련된 첨부 파일을 다운로드합니다.
  4. Aranda Service Management Suite에서 KB(기술 자료) 문서를 검색합니다.
  5. 기술 자료(KB) 문서에서 첨부 파일을 다운로드합니다.
  6. 구성 항목 만들기, 검색 및 업데이트(CI).
  7. 이를 통해 조직은 내부 지원 요청을 해결하고 기술 문제 해결 프로세스를 관리하고 간소화할 수 있습니다.
  8. 요청자와 지원 에이전트 간의 통신 추적을 허용합니다.
  9. 요청자에게 티켓 상태를 알리는 자동화된 응답을 제공합니다.

성공적인 응답

코드 이름 Description
200 그래 요청이 성공했습니다.
204 내용 없음 요청에서 데이터를 찾을 수 없음

일반적인 오류 및 해결

코드 이름 Description 해결 방법
400 잘못된 요청 CriteriaNeedsSomeArguments 검색 매개 변수가 비어 있지 않은지 확인합니다.
400 잘못된 요청 InvalidAdditionalFieldId 추가 필드의 ID가 올바른지 확인합니다.
400 잘못된 요청 InvalidItemType 사례 유형이 잘못되었습니다. 사례 유형 ID를 변경합니다.
400 잘못된 요청 InvalidProjectId 프로젝트 ID가 잘못되었습니다. 사례를 연결할 프로젝트 ID를 변경합니다.
400 잘못된 요청 InvalidStateId 티켓을 만들거나 업데이트할 때 추가된 상태 확인
400 잘못된 요청 InvalidUploadType 파일을 첨부할 때 오류 발생, 시스템 관리자의 지원 요청
400 잘못된 요청 RequestNeedsSomeArguments 티켓의 필수 필드를 확인하고 커넥터에 해당 값을 추가합니다.
400 잘못된 요청 SearchListIsRequired 시스템 관리자의 지원 요청
400 잘못된 요청 매개 변수 이름: {Name 매개 변수} 오류에 언급된 속성이 null이 아닌지 확인합니다.
400 잘못된 요청 null 매개 변수 이름입니다. {Name 매개 변수} 오류에 언급된 속성이 null이 아닌지 확인합니다.
400 잘못된 요청 ItemTypeIsRequired 사례 유형 추가
400 잘못된 요청 ModelIdIsEmpty modelId 매개 변수를 추가합니다. 필수 항목입니다.
400 잘못된 요청 StateIdIsEmpty stateId 매개 변수를 추가합니다. 필수 항목입니다.
400 잘못된 요청 ServiceIdIsEmpty serviceId 매개 변수를 추가합니다. 필수 항목입니다.
400 잘못된 요청 CategoryIdIsEmpty categoryId 매개 변수를 추가합니다. 필수 항목입니다.
400 잘못된 요청 TypesListNeedsSomeArguments 티켓을 검색할 때 사례 유형을 추가해야 하며 시스템 관리자의 지원 요청
400 잘못된 요청 '{PARAMETER_NAME}' AdditionalFieldIsRequired 추가 필드 '{PARAMETER_NAME}'은(는) 필수입니다.
400 잘못된 요청 ModelNotActive 사례와 연결된 모델이 활성 상태가 아닙니다.
400 잘못된 요청 FailedToCloseTaskPendingCloseTasksPredecessors 대/소문자를 닫으려고 하면 부모 사례에 닫을 보류 중인 작업이 있는 경우
400 잘못된 요청 DuplicatedObject Ci가 데이터베이스에 이미 있습니다.
400 잘못된 요청 EmptyValue 매개 변수 이름: {PARAMETER_NAME} {PARAMETER_NAME} 매개 변수가 필요합니다.
400 잘못된 요청 EmptyEnumeration 매개 변수 이름: {PARAMETER_NAME} {PARAMETER_NAME} 매개 변수는 목록이며 필수 항목입니다.
403 금지 DoNotHavePermissionForThisAction 시스템 관리자에게 문의하여 사용 권한 할당
코드 이름 Description 해결 방법
500 내부 서버 오류 시스템 관리자의 지원 요청
500 내부 서버 오류 FailureExportExcel 시스템 관리자의 지원 요청
500 내부 서버 오류 FailureGetAdditionalFields 시스템 관리자의 지원 요청
500 내부 서버 오류 FailureGetCategoriesByService 시스템 관리자의 지원 요청
500 내부 서버 오류 FailureGetChangeFSC 시스템 관리자의 지원 요청
500 내부 서버 오류 FailureGetFields 시스템 관리자의 지원 요청
500 내부 서버 오류 FailureGetFieldsList 시스템 관리자의 지원 요청
500 내부 서버 오류 FailureGetFiles 시스템 관리자의 지원 요청
500 내부 서버 오류 FailureGetLookupValues 시스템 관리자의 지원 요청
500 내부 서버 오류 FailureGetMailTemplates 시스템 관리자의 지원 요청
500 내부 서버 오류 FailureGetModelByCategory 시스템 관리자의 지원 요청
500 내부 서버 오류 FailureGetOperators 시스템 관리자의 지원 요청
500 내부 서버 오류 FailureGetReassignmentReasons 시스템 관리자의 지원 요청
500 내부 서버 오류 FailureGetSimilarItems 시스템 관리자의 지원 요청
500 내부 서버 오류 FailureSearchQuickManagement 시스템 관리자의 지원 요청

자주 묻는 질문(FAQ)

  1. 커넥터에서 다양한 작업을 사용하는 데 필요한 특성의 ID를 검색하는 방법(예: 프로젝트, 서비스, 범주, 그룹, 전문가)?

    ID는 여러 가지 방법으로 검색할 수 있습니다.

    • Aranda 쿼리 관리자를 사용하여 필요한 데이터가 있는 ASMS(Aranda Service Management Suite) 테이블을 쿼리하는 보고서를 만들 수 있습니다. 솔루션의 데이터 개체에 대한 지침이 필요한 경우 다음 링크를 https://docs.arandasoft.com/docs/database.html 방문하여 ASMS 설치에 해당하는 Aranda 데이터베이스 버전을 식별합니다.
    • ASMS 온-프레미스 설치를 사용하는 경우 SQL 클라이언트를 통해 필요한 데이터가 있는 ASMS 테이블을 쿼리할 수 있습니다.
    • Aranda 지원 센터를 통해 다음 웹 사이트 지원에 표시된 연락처 채널을 통해 지원 요청을 만듭니다.

  2. "첨부 파일 추가" 작업을 사용할 때 첨부할 파일의 최대 크기는 어떻게 됩니까?

    최대 크기는 ASMS 인스턴스/설치의 특정 구성에 따라 달라집니다. ASMS 관리자에게 문의하세요.

  3. 커넥터에 필요한 ASMS 연결 구성에 토큰이 사용되는 기술자 계정에 필요한 데이터 액세스 수준은 무엇인가요?

    액세스 수준은 ASMS에서 정기적으로 사용되는 기술자 계정과 동일합니다. 즉, ASMS에서 해당 기술자의 역할 및 권한에 따라 커넥터를 사용하여 데이터에 액세스할 수 있습니다.

  4. 커넥터에서 토큰을 사용할 기술자 계정이 명명 또는 동시이어야 하나요?

    커넥터는 시간당 여러 번 관련 ASMS 인스턴스에 액세스할 수 있으므로 계정이 명명된 형식인 것이 좋습니다.

  5. 커넥터를 사용하여 사례를 만들거나 수정하는 경우 ASMS 인터페이스에 있는 것과 동일한 데이터 유효성 검사 규칙을 따르나요?

    예, 동일한 유효성 검사 규칙을 따릅니다. 예를 들어 특정 프로젝트, 서비스 및 범주에 대한 사례를 만들 때 네이티브 및 추가 필드를 채워야 하는 경우 커넥터를 통해 사례를 제출할 때도 이러한 데이터가 필요합니다.

  6. 클라우드 및 온-프레미스 환경에서 ASMS 인스턴스에 커넥터를 사용할 수 있나요?

    예, ASMS의 클라우드 및 온-프레미스 설치 모두에서 사용할 수 있습니다. 온-프레미스 설치에서는 ASMS 서버와 Power Automate 환경 간의 연결을 고려해야 합니다.

  7. 표준 커넥터만 사용할 수 있는 Power Automate 라이선스가 있습니다. ASMS 커넥터를 사용할 수 있나요?

    ASMS 커넥터는 프리미엄 유형이므로 불가능합니다.

  8. Power Automate에서 ASMS의 이벤트(예: 케이스가 생성된 경우, 특정 그룹에 사례가 할당된 경우)에서 시작하는 흐름을 만들려고 합니다. ASMS에서 발생하는 이벤트에서 시작하는 트리거를 사용할 수 있나요?

    예, 가능합니다. 다음 단계를 수행하는 것이 좋습니다.

    • "HTTP 요청을 받은 경우" 트리거를 초기화하고 ASMS에서 수신될 것으로 예상되는 데이터 구조를 포함하는 요청 본문 JSON 스키마를 만듭니다. 트리거가 만들어지면 ASMS 인스턴스에서 사용할 HTTP POST URL(WebHook URL)을 받게 됩니다. WebHook URL(예: 토큰)에 액세스하는 인증 메커니즘을 고려하는 것을 잊지 마세요.
    • 충족될 때 Power Automate에서 흐름을 시작해야 하는 조건 집합에 대한 비즈니스 규칙을 ASMS에 만듭니다. 규칙 내에서 작업으로 "웹후크 호출"을 선택하고 호출 대상 URL에 이전에 가져온 WebHook URL, 보낼 매개 변수 및 요청 본문(요청 본문 JSON 스키마와 일치해야 함)을 입력합니다. ASMS의 규칙에서 웹후크를 호출하는 방법에 대한 자세한 내용은 다음 링크를 참조하세요. 웹후크 규칙
    • 만든 규칙을 테스트하고 HTTP 요청이 WebHook URL로 전송되고 Power Automate에서 흐름을 초기화하는지 확인합니다.

  9. POWER Automate에서 흐름의 작업으로 ASMS REST API 엔드포인트를 호출할 수 있나요?

    예, 가능합니다. "HTTP" 작업을 사용하고 필요한 데이터(URI, 메서드, 헤더, 본문 등)를 입력합니다.

연결을 만드는 중

커넥터는 다음 인증 유형을 지원합니다.
기본값 연결을 만들기 위한 매개 변수입니다. 모든 지역 공유할 수 없음

기본값

적용 가능: 모든 지역

연결을 만들기 위한 매개 변수입니다.

공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.

이름 유형 Description 필수
API 키 시큐어스트링 (보안 문자열) 이 API의 API 키 진실

제한 한도

Name 호출 갱신 기간
연결당 API 호출 100 60초

동작

ID로 그룹 가져오기

지정된 ID를 가진 그룹을 가져옵니다.
결제를 지급으로 표시

결제를 "유료"로 닫습니다. 결제 요청 포털 이외의 수단을 통해 지불되는 경우 이 엔드포인트를 사용합니다. 이렇게 하면 결제가 종료되고 해당 지불 금액이 통계에 추가됩니다. 이 엔드포인트는 텍스트 요청을 통해 전송된 결제 포털을 통해 결제하는 데 필요하지 않습니다. 결제를 자동으로 지급으로 표시하는 입니다.
계정의 모든 대시보드 가져오기

계정의 모든 대시보드를 가져옵니다.
대화 보관

대화를 보관하여 모든 대화 검색 엔드포인트의 결과에서 제거합니다. 고객이 텍스트 요청 번호로 텍스트를 보내거나 텍스트 요청 번호에서 텍스트를 보내는 경우 대화는 자동으로 보관되지 않습니다. 대화를 보관하는 것은 나중에 대화할 계획이 없는 고객의 혼란을 제거하는 좋은 방법입니다. 고객이 추가 SMS 메시지를 보내지 못하도록 "STOP"의 텍스트를 보내면 대화가 자동으로 보관됩니다.
대화 상대의 전화 번호로 대화 메시지 가져오기

지정된 대시보드와 전화 번호 간의 대화를 가져옵니다.
모든 결제를 가져옵니다.

취소된 결제 및 지불된 결제를 포함하여 모든 결제를 가져옵니다. 쿼리 매개 변수를 사용하여 필터링할 수 있습니다.
모든 그룹 가져옵니다.

사용자 계정에 대한 모든 그룹을 가져옵니다.
모든 사용자 지정 필드를 가져옵니다.

이 대시보드에 대한 모든 사용자 지정 필드를 가져옵니다. 사용자 지정 필드는 대시보드 간에 고유합니다.
모든 태그를 가져옵니다.

이 대시보드의 모든 태그를 가져옵니다. 태그는 대시보드 간에 고유합니다.
무정부 상태의 대화

대화를 무정부 상태로 만듭니다. 대화가 비정부화되면 큐에 다시 나타납니다. /conversations 엔드포인트에서 반환된 대화에도 표시됩니다. 대화가 이미 보관되지 않은 경우 이 메서드는 아무런 영향을 주지 않습니다.
사용자에게 지정된 결제를 지불하도록 상기시키는 후속 텍스트 보내기

연락처에 미리 알림을 보내 지정된 결제 금액을 지불합니다. 메시지 내용이 자동으로 생성됩니다. 스팸을 방지하기 위해 결제당 하나의 미리 알림만 보낼 수 있습니다.
새 결제를 만듭니다.

제공된 연락처에 제공된 메시지를 사용하여 새 결제를 만듭니다.
새 그룹을 만듭니다.

제공된 이름을 사용하여 새 그룹을 만듭니다.
연락처 대량 업데이트

지정된 대시보드에만 연락처가 추가됩니다. 연락처는 대시보드별로 구성되며 사용할 수 있는 숫자에 대한 계정 수준 검색은 없습니다.
연락처 만들기 또는 업데이트

연락처를 만들거나 업데이트합니다(지정된 전화 번호가 이미 있는지 여부에 따라 다름).
이 대시보드에 대한 모든 대화를 가져옵니다.

이 대시보드에 대한 모든 대화를 가져오고 각 대화의 마지막 메시지에 대한 정보를 포함합니다.
이 특정 대시보드에 대한 정보 가져오기

대시보드의 이름과 휴대폰을 반환합니다.
지정된 ID로 그룹을 업데이트합니다.

그룹의 숫자 ID를 사용하여 그룹의 이름을 업데이트합니다. 전달된 그룹 ID가 없으면 호출이 실패합니다.
지정된 ID를 사용하여 결제를 가져옵니다.

지정된 ID를 사용하여 결제를 가져옵니다.
지정된 ID를 사용하여 그룹을 삭제합니다.

지정된 ID를 사용하여 그룹을 삭제합니다. 그룹의 구성원인 연락처가 있는 경우에도 성공합니다(연락처는 삭제되지 않음).
지정된 결제를 취소합니다.

지정된 결제를 취소하고 결제가 취소되었음을 사용자에게 문자 메시지로 전달합니다. 결제는 편집할 수 없으므로 새 결제를 취소하고 발행하는 것이 결제를 수정하는 가장 좋은 방법입니다.
지정된 대시보드를 삭제합니다.

지정된 대시보드를 삭제합니다.
지정된 이름 및 전화 번호를 사용하여 새 대시보드 만들기

계정에 새 대시보드를 만듭니다. 대시보드가 만들어지면 관리자에게 변경 내용에 대한 전자 메일을 보내 사용자 할당을 시작할 수 있습니다. 이 엔드포인트는 프로비전된 숫자에 대한 대시보드를 만들 수 있습니다. GET /dashboards/provisioning을 사용하여 특정 지역 코드에서 프로비전된 숫자를 검색할 수 있습니다. 전화 번호가 이미 사용 중인 경우 잘못된 요청 예외가 throw됩니다.
지정된 전화 번호가 있는 연락처를 가져옵니다.

지정된 전화 번호가 있는 연락처를 가져옵니다.
지정된 전화 번호가 있는 연락처를 삭제합니다.

지정된 전화 번호가 있는 연락처를 삭제합니다.
지정된 전화 번호로 연락처에 메시지 보내기

메시지를 보냅니다(지정된 전화 번호에 메시지 기록이 없는 경우 새 대화 시작).
지정된 필터링 조건과 일치하는 모든 연락처 가져오기

지정된 필터링 조건과 일치하는 모든 연락처를 가져옵니다. 지정된 대시보드만 검색됩니다. 사용할 수 있는 숫자에 대한 계정 수준 검색이 없습니다.
특정 대시보드의 이름 업데이트

대시보드를 업데이트합니다. 대시보드의 전화 번호는 변경되지 않습니다. 다른 대시보드의 연락처가 있는 새 번호를 원하는 경우 POST를 사용하여 새 대시보드를 만들고 대량 내보내기/가져오기를 사용하여 연락처를 추가해야 합니다.

ID로 그룹 가져오기

작업 ID:
GetGroupById

지정된 ID를 가진 그룹을 가져옵니다.

매개 변수

Name 키 필수 형식 Description
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.
그룹의 ID
 group_id True integer

가져올 그룹의 숫자 ID입니다.

반환

Name 경로 형식 Description
아이디
 id integer

그룹의 숫자 ID입니다.
group_member_count
 group_member_count integer

그룹의 멤버 수입니다.
is_keyword
 is_keyword boolean

이 그룹은 키워드 그룹입니다. 이러한 그룹은 사용자가 키워드를 설정할 때 자동으로 생성됩니다. 연락처는 등록할 때 자동으로 추가됩니다.
이름
 name string

이 그룹의 이름입니다.
메모
 notes string

이 그룹에 대한 모든 참고 사항입니다.
last_message_sent_utc
 last_message_sent_utc string

이 그룹에 대한 마지막 그룹 메시지를 보낸 시기의 타임스탬프입니다.

결제를 지급으로 표시

작업 ID:
MarkPaymentPaid

결제를 "유료"로 닫습니다. 결제 요청 포털 이외의 수단을 통해 지불되는 경우 이 엔드포인트를 사용합니다. 이렇게 하면 결제가 종료되고 해당 지불 금액이 통계에 추가됩니다. 이 엔드포인트는 텍스트 요청을 통해 전송된 결제 포털을 통해 결제하는 데 필요하지 않습니다. 결제를 자동으로 지급으로 표시하는 입니다.

매개 변수

Name 키 필수 형식 Description
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.
결제 ID
 payment_id True integer

업데이트할 결제의 숫자 ID입니다.

반환

Name 경로 형식 Description
payment_id
 payment_id integer

결제의 숫자 ID입니다.
request_date
 request_date string

이 결제의 초기 메시지가 전송될 큐에 대기된 시점의 타임스탬프입니다.
수령인
 recipient string

결제 받는 사람의 이름입니다. 연락처에 전화 번호와 연결된 이름이 없는 경우 null일 수 있습니다.
description
 description string

지불에 대한 설명입니다. 연락처에 표시되지 않습니다. 내부 사용자가 결제에 대한 컨텍스트에만 사용됩니다.
customer_phone
 customer_phone string

이 결제를 보낼 연락처의 전화 번호입니다.
amount_requested
 amount_requested float

이 지불에서 요청한 달러 금액입니다.
is_past_due
 is_past_due boolean

이 지불이 요청 날짜를 지났는지 여부입니다.
reminder_was_sent
 reminder_was_sent boolean

이 결제를 위해 텍스트 미리 알림이 이미 전송되었는지 여부입니다.
transaction_status
 transaction_status string

인증에서 트랜잭션의 상태입니다. 이 값은 알 수 없음으로 시작합니다.
textrequest_payment_status
 textrequest_payment_status string

텍스트 요청의 트랜잭션 상태입니다. 텍스트 요청 앱의 결제 페이지에 표시되는 상태를 나타냅니다. Sent로 시작합니다.
reference_number
 reference_number string

신속하게 결제를 찾는 데 사용할 수 있는 결제가 생성될 때 정의된 사용자 정의 ID입니다. 참조 번호는 고유하지 않습니다. 많은 결제에 동일한 참조가 있을 수 있습니다.

계정의 모든 대시보드 가져오기

작업 ID:
GetDashboards

계정의 모든 대시보드를 가져옵니다.

매개 변수

Name 키 필수 형식 Description
가져올 번호 페이지
 page integer

가져올 엔터티의 페이지입니다. 값을 가져올 때 페이지당 최대 크기가 page_size 정의됩니다. 페이지가 마지막 페이지보다 크면 빈 배열이 반환됩니다.
페이지당 가져올 각 엔터티의 양
 page_size integer

가져올 각 페이지의 크기입니다. 값을 가져올 때 페이지 매개 변수에서 수행된 후속 페이지에 액세스하는 페이지당 최대 크기입니다.

반환

Name 경로 형식 Description
page
 meta.page integer

받은 엔터티 페이지입니다. 이 페이지의 엔터티 양은 page_size 정의됩니다.
page_size
 meta.page_size integer

이 페이지에서 받은 엔터티 수입니다.
total_items
 meta.total_items integer

페이지 크기 또는 수에 관계없이 데이터베이스에서 사용할 수 있는 엔터티 수입니다. 다른 페이지를 보려면 요청의 페이지 번호를 변경합니다.
items
 items array of object

텍스트 요청에서 얻은 대시보드 엔터티 목록입니다.
아이디
 items.id integer

대시보드의 숫자 ID입니다.
이름
 items.name string

대시보드의 이름입니다.
phone
 items.phone string

이 대시보드와 연결된 문자 메시지 번호입니다.

대화 보관

작업 ID:
ArchiveConversation

대화를 보관하여 모든 대화 검색 엔드포인트의 결과에서 제거합니다. 고객이 텍스트 요청 번호로 텍스트를 보내거나 텍스트 요청 번호에서 텍스트를 보내는 경우 대화는 자동으로 보관되지 않습니다. 대화를 보관하는 것은 나중에 대화할 계획이 없는 고객의 혼란을 제거하는 좋은 방법입니다. 고객이 추가 SMS 메시지를 보내지 못하도록 "STOP"의 텍스트를 보내면 대화가 자동으로 보관됩니다.

매개 변수

Name 키 필수 형식 Description
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.
대화의 전화 번호
 phone_number True string

보관할 대화의 전화 번호입니다.

반환

response
string

대화 상대의 전화 번호로 대화 메시지 가져오기

작업 ID:
GetMessagesByContactPhone

지정된 대시보드와 전화 번호 간의 대화를 가져옵니다.

매개 변수

Name 키 필수 형식 Description
가져올 번호 페이지
 page True integer

가져올 엔터티의 페이지입니다. 값을 가져올 때 페이지당 최대 크기가 page_size 정의됩니다. 페이지가 마지막 페이지보다 크면 빈 배열이 반환됩니다.
페이지당 가져올 각 엔터티의 양
 page_size True integer

가져올 각 페이지의 크기입니다. 값을 가져올 때 페이지 매개 변수에서 수행된 후속 페이지에 액세스하는 페이지당 최대 크기입니다.
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.
검색할 연락처의 전화 번호
 phone_number True string

메시지를 가져올 연락처의 전화 번호입니다.

반환

Name 경로 형식 Description
page
 meta.page integer

받은 엔터티 페이지입니다. 이 페이지의 엔터티 양은 page_size 정의됩니다.
page_size
 meta.page_size integer

이 페이지에서 받은 엔터티 수입니다.
total_items
 meta.total_items integer

페이지 크기 또는 수에 관계없이 데이터베이스에서 사용할 수 있는 엔터티 수입니다. 다른 페이지를 보려면 요청의 페이지 번호를 변경합니다.
items
 items array of object

텍스트 요청에서 받은 메시지 엔터티 목록입니다.
message_id
 items.message_id string

메시지의 ID입니다. 이 값은 각 메시지에 대해 고유합니다.
body
 items.body string

이 메시지의 내용입니다.
message_direction
 items.message_direction string

이 메시지가 연락처에서 수신되었는지 또는 보낸 것인지를 나타내는 R 또는 S의 단수 문자입니다.
response_by_username
 items.response_by_username string

이 사용자에게 마지막으로 메시지를 보낸 텍스트 요청 사용자의 사용자 이름입니다.
message_timestamp_utc
 items.message_timestamp_utc string

텍스트 요청에서 메시지를 보내거나 받은 시기의 타임스탬프입니다.
delivery_status
 items.delivery_status string

이 메시지의 현재 상태입니다. 'send', 'delivered', 'error' 또는 'send'일 수 있습니다.
delivery_error
 items.delivery_error string

이 메시지가 배달되지 않는 오류가 발생했습니다. delivery_status 'error'가 아니면 이 값은 null이 됩니다.
mms_media
 items.mms_media array of string

이 메시지의 첨부 파일을 가리키는 URL 목록입니다. 모든 URL은 텍스트 요청 생성 URL입니다.

모든 결제를 가져옵니다.

작업 ID:
GetPayments

취소된 결제 및 지불된 결제를 포함하여 모든 결제를 가져옵니다. 쿼리 매개 변수를 사용하여 필터링할 수 있습니다.

매개 변수

Name 키 필수 형식 Description
결제의 참조 문자열
 reference_number string

결제를 신속하게 찾는 데 사용할 수 있는 결제가 생성될 때 정의된 사용자 정의 ID입니다. 참조 번호는 고유하지 않습니다. 많은 결제에 동일한 참조가 있을 수 있습니다.
결제 전화 번호
 phone_number string

이 결제가 전송된 연락처의 전화 번호입니다.
정렬 기준
 sort_type string

결제 기준으로 정렬할 속성입니다. "amount", "contact", "date", "status"일 수 있습니다.
정렬 방향
 sort_direction string

결제를 정렬하는 방향입니다. 가장 큰 값에서 가장 작은 경우 "desc", 가장 작거나 가장 큰 경우 "asc"일 수 있습니다.
가져올 번호 페이지
 page True integer

가져올 엔터티의 페이지입니다. 값을 가져올 때 페이지당 최대 크기가 page_size 정의됩니다. 페이지가 마지막 페이지보다 크면 빈 배열이 반환됩니다.
페이지당 가져올 각 엔터티의 양
 page_size True integer

가져올 각 페이지의 크기입니다. 값을 가져올 때 페이지 매개 변수에서 수행된 후속 페이지에 액세스하는 페이지당 최대 크기입니다.
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.

반환

Name 경로 형식 Description
page
 meta.page integer

받은 엔터티 페이지입니다. 이 페이지의 엔터티 양은 page_size 정의됩니다.
page_size
 meta.page_size integer

이 페이지에서 받은 엔터티 수입니다.
total_items
 meta.total_items integer

페이지 크기 또는 수에 관계없이 데이터베이스에서 사용할 수 있는 엔터티 수입니다. 다른 페이지를 보려면 요청의 페이지 번호를 변경합니다.
items
 items array of object

텍스트 요청에서 받은 결제 엔터티 목록입니다.
payment_id
 items.payment_id integer

결제의 숫자 ID입니다.
request_date
 items.request_date string

이 결제의 초기 메시지가 전송될 큐에 대기된 시점의 타임스탬프입니다.
수령인
 items.recipient string

결제 받는 사람의 이름입니다. 연락처에 전화 번호와 연결된 이름이 없는 경우 null일 수 있습니다.
description
 items.description string

지불에 대한 설명입니다. 연락처에 표시되지 않습니다. 내부 사용자가 결제에 대한 컨텍스트에만 사용됩니다.
customer_phone
 items.customer_phone string

이 결제를 보낼 연락처의 전화 번호입니다.
amount_requested
 items.amount_requested float

이 지불에서 요청한 달러 금액입니다.
is_past_due
 items.is_past_due boolean

이 지불이 요청 날짜를 지났는지 여부입니다.
reminder_was_sent
 items.reminder_was_sent boolean

이 결제를 위해 텍스트 미리 알림이 이미 전송되었는지 여부입니다.
transaction_status
 items.transaction_status string

인증에서 트랜잭션의 상태입니다. 이 값은 알 수 없음으로 시작합니다.
textrequest_payment_status
 items.textrequest_payment_status string

텍스트 요청의 트랜잭션 상태입니다. 텍스트 요청 앱의 결제 페이지에 표시되는 상태를 나타냅니다. Sent로 시작합니다.
reference_number
 items.reference_number string

신속하게 결제를 찾는 데 사용할 수 있는 결제가 생성될 때 정의된 사용자 정의 ID입니다. 참조 번호는 고유하지 않습니다. 많은 결제에 동일한 참조가 있을 수 있습니다.

모든 그룹 가져옵니다.

작업 ID:
GetGroups

사용자 계정에 대한 모든 그룹을 가져옵니다.

매개 변수

Name 키 필수 형식 Description
가져올 번호 페이지
 page True integer

가져올 엔터티의 페이지입니다. 값을 가져올 때 페이지당 최대 크기가 page_size 정의됩니다. 페이지가 마지막 페이지보다 크면 빈 배열이 반환됩니다.
페이지당 가져올 각 엔터티의 양
 page_size True integer

가져올 각 페이지의 크기입니다. 값을 가져올 때 페이지 매개 변수에서 수행된 후속 페이지에 액세스하는 페이지당 최대 크기입니다.
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.

반환

Name 경로 형식 Description
page
 meta.page integer

받은 엔터티 페이지입니다. 이 페이지의 엔터티 양은 page_size 정의됩니다.
page_size
 meta.page_size integer

이 페이지에서 받은 엔터티 수입니다.
total_items
 meta.total_items integer

페이지 크기 또는 수에 관계없이 데이터베이스에서 사용할 수 있는 엔터티 수입니다. 다른 페이지를 보려면 요청의 페이지 번호를 변경합니다.
items
 items array of object

텍스트 요청에서 얻은 그룹 엔터티 목록입니다.
아이디
 items.id integer

그룹의 숫자 ID입니다.
group_member_count
 items.group_member_count integer

그룹의 멤버 수입니다.
is_keyword
 items.is_keyword boolean

이 그룹은 키워드 그룹입니다. 이러한 그룹은 사용자가 키워드를 설정할 때 자동으로 생성됩니다. 연락처는 등록할 때 자동으로 추가됩니다.
이름
 items.name string

이 그룹의 이름입니다.
메모
 items.notes string

이 그룹에 대한 모든 참고 사항입니다.
last_message_sent_utc
 items.last_message_sent_utc string

이 그룹에 대한 마지막 그룹 메시지를 보낸 시기의 타임스탬프입니다.

모든 사용자 지정 필드를 가져옵니다.

작업 ID:
GetCustomFields

이 대시보드에 대한 모든 사용자 지정 필드를 가져옵니다. 사용자 지정 필드는 대시보드 간에 고유합니다.

매개 변수

Name 키 필수 형식 Description
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.

반환

Name 경로 형식 Description
array of object
아이디
 id string

필드의 숫자 ID입니다.
이름
 name string

사용자 지정 필드의 이름입니다.

모든 태그를 가져옵니다.

작업 ID:
GetTags

이 대시보드의 모든 태그를 가져옵니다. 태그는 대시보드 간에 고유합니다.

매개 변수

Name 키 필수 형식 Description
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.
가져올 번호 페이지
 page True integer

가져올 엔터티의 페이지입니다. 값을 가져올 때 페이지당 최대 크기가 page_size 정의됩니다. 페이지가 마지막 페이지보다 크면 빈 배열이 반환됩니다.
페이지당 가져올 각 엔터티의 양
 page_size True integer

가져올 각 페이지의 크기입니다. 값을 가져올 때 페이지 매개 변수에서 수행된 후속 페이지에 액세스하는 페이지당 최대 크기입니다.

반환

Name 경로 형식 Description
page
 meta.page integer

받은 엔터티 페이지입니다. 이 페이지의 엔터티 양은 page_size 정의됩니다.
page_size
 meta.page_size integer

이 페이지에서 받은 엔터티 수입니다.
total_items
 meta.total_items integer

페이지 크기 또는 수에 관계없이 데이터베이스에서 사용할 수 있는 엔터티 수입니다. 다른 페이지를 보려면 요청의 페이지 번호를 변경합니다.
items
 items array of object

텍스트 요청에서 얻은 태그 엔터티 목록입니다.
아이디
 items.id string

태그의 숫자 ID입니다.
tag_color
 items.tag_color string

태그의 색입니다. 유효한 16진수 색 코드여야 합니다.
tag
 items.tag string

태그의 이름입니다.

무정부 상태의 대화

작업 ID:
UnarchiveConversation

대화를 무정부 상태로 만듭니다. 대화가 비정부화되면 큐에 다시 나타납니다. /conversations 엔드포인트에서 반환된 대화에도 표시됩니다. 대화가 이미 보관되지 않은 경우 이 메서드는 아무런 영향을 주지 않습니다.

매개 변수

Name 키 필수 형식 Description
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.
대화의 전화 번호
 phone_number True string

보관할 대화의 전화 번호입니다.

반환

response
string

사용자에게 지정된 결제를 지불하도록 상기시키는 후속 텍스트 보내기

작업 ID:
SendPaymentReminder

연락처에 미리 알림을 보내 지정된 결제 금액을 지불합니다. 메시지 내용이 자동으로 생성됩니다. 스팸을 방지하기 위해 결제당 하나의 미리 알림만 보낼 수 있습니다.

매개 변수

Name 키 필수 형식 Description
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.
결제 ID
 payment_id True integer

업데이트할 결제의 숫자 ID입니다.

반환

Name 경로 형식 Description
payment_id
 payment_id integer

결제의 숫자 ID입니다.
request_date
 request_date string

이 결제의 초기 메시지가 전송될 큐에 대기된 시점의 타임스탬프입니다.
수령인
 recipient string

결제 받는 사람의 이름입니다. 연락처에 전화 번호와 연결된 이름이 없는 경우 null일 수 있습니다.
description
 description string

지불에 대한 설명입니다. 연락처에 표시되지 않습니다. 내부 사용자가 결제에 대한 컨텍스트에만 사용됩니다.
customer_phone
 customer_phone string

이 결제를 보낼 연락처의 전화 번호입니다.
amount_requested
 amount_requested float

이 지불에서 요청한 달러 금액입니다.
is_past_due
 is_past_due boolean

이 지불이 요청 날짜를 지났는지 여부입니다.
reminder_was_sent
 reminder_was_sent boolean

이 결제를 위해 텍스트 미리 알림이 이미 전송되었는지 여부입니다.
transaction_status
 transaction_status string

인증에서 트랜잭션의 상태입니다. 이 값은 알 수 없음으로 시작합니다.
textrequest_payment_status
 textrequest_payment_status string

텍스트 요청의 트랜잭션 상태입니다. 텍스트 요청 앱의 결제 페이지에 표시되는 상태를 나타냅니다. Sent로 시작합니다.
reference_number
 reference_number string

신속하게 결제를 찾는 데 사용할 수 있는 결제가 생성될 때 정의된 사용자 정의 ID입니다. 참조 번호는 고유하지 않습니다. 많은 결제에 동일한 참조가 있을 수 있습니다.

새 결제를 만듭니다.

작업 ID:
CreatePayment

제공된 연락처에 제공된 메시지를 사용하여 새 결제를 만듭니다.

매개 변수

Name 키 필수 형식 Description
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.
결제 설명
 description string

지불에 대한 설명입니다. 설명은 연락처에 표시되지 않으며 내부 사용자가 결제에 대한 컨텍스트에만 사용됩니다.
받는 사람 전화 번호
 customer_phone string

이 결제가 전송될 연락처의 전화 번호입니다.
요청된 금액(달러)
 amount_requested float

이 지불에서 요청한 달러 금액입니다.
결제 메시지 텍스트 본문
 message string

결제 링크와 함께 연락처로 보낼 메시지 텍스트입니다.
결제의 참조 문자열
 reference_number string

결제를 신속하게 찾는 데 사용할 수 있는 결제가 생성될 때 정의된 사용자 정의 ID입니다. 참조 번호는 고유하지 않습니다. 많은 결제에 동일한 참조가 있을 수 있습니다.

반환

Name 경로 형식 Description
payment_id
 payment_id integer

결제의 숫자 ID입니다.
request_date
 request_date string

이 결제의 초기 메시지가 전송될 큐에 대기된 시점의 타임스탬프입니다.
수령인
 recipient string

결제 받는 사람의 이름입니다. 연락처에 전화 번호와 연결된 이름이 없는 경우 null일 수 있습니다.
description
 description string

지불에 대한 설명입니다. 연락처에 표시되지 않습니다. 내부 사용자가 결제에 대한 컨텍스트에만 사용됩니다.
customer_phone
 customer_phone string

이 결제를 보낼 연락처의 전화 번호입니다.
amount_requested
 amount_requested float

이 지불에서 요청한 달러 금액입니다.
is_past_due
 is_past_due boolean

이 지불이 요청 날짜를 지났는지 여부입니다.
reminder_was_sent
 reminder_was_sent boolean

이 결제를 위해 텍스트 미리 알림이 이미 전송되었는지 여부입니다.
transaction_status
 transaction_status string

인증에서 트랜잭션의 상태입니다. 이 값은 알 수 없음으로 시작합니다.
textrequest_payment_status
 textrequest_payment_status string

텍스트 요청의 트랜잭션 상태입니다. 텍스트 요청 앱의 결제 페이지에 표시되는 상태를 나타냅니다. Sent로 시작합니다.
reference_number
 reference_number string

신속하게 결제를 찾는 데 사용할 수 있는 결제가 생성될 때 정의된 사용자 정의 ID입니다. 참조 번호는 고유하지 않습니다. 많은 결제에 동일한 참조가 있을 수 있습니다.

새 그룹을 만듭니다.

작업 ID:
CreateGroup

제공된 이름을 사용하여 새 그룹을 만듭니다.

매개 변수

Name 키 필수 형식 Description
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.
그룹 이름
 name string

그룹의 새 이름입니다.
그룹 메모
 notes string

그룹을 설명하는 짧은 구입니다. 편의를 위해 사용됩니다.

반환

Name 경로 형식 Description
아이디
 id integer

그룹의 숫자 ID입니다.
group_member_count
 group_member_count integer

그룹의 멤버 수입니다.
is_keyword
 is_keyword boolean

이 그룹은 키워드 그룹입니다. 이러한 그룹은 사용자가 키워드를 설정할 때 자동으로 생성됩니다. 연락처는 등록할 때 자동으로 추가됩니다.
이름
 name string

이 그룹의 이름입니다.
메모
 notes string

이 그룹에 대한 모든 참고 사항입니다.
last_message_sent_utc
 last_message_sent_utc string

이 그룹에 대한 마지막 그룹 메시지를 보낸 시기의 타임스탬프입니다.

연락처 대량 업데이트

작업 ID:
BulkUpdateContacts

지정된 대시보드에만 연락처가 추가됩니다. 연락처는 대시보드별로 구성되며 사용할 수 있는 숫자에 대한 계정 수준 검색은 없습니다.

매개 변수

Name 키 필수 형식 Description
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.
연락처 전화 번호
 phone_number string

만들거나 업데이트할 연락처의 전화 번호입니다.
연락처의 이름
 first_name string

연락처의 새 이름입니다.
연락처의 성
 last_name string

연락처의 새 성입니다.
연락처의 전체 이름
 display_name string

연락처의 새 전체 이름입니다. 연락처를 볼 때 웹앱에 표시되는 기본 이름입니다.
이 연락처의 메시지가 표시되지 않는지 여부
 is_suppressed boolean

이 연락처와의 대화가 표시되지 않도록 하여 수신 시 메시지 큐의 맨 위로 푸시되지 않는지 여부를 결정합니다.
이 연락처의 메시지가 보관되는지 여부
 is_archived boolean

이 연락처와의 대화가 보관되는지 여부를 결정하므로 대화를 쿼리할 때(기본적으로) 볼 수 없습니다.
이 연락처의 메시지가 차단되는지 여부
 is_blocked boolean

이 연락처와의 대화가 차단되어 수신되거나 저장되지 않는지 여부를 결정합니다.
이 연락처를 표시하지 않는 이유
 suppressed_reason string

접촉을 표시하지 않는 이유를 설명하는 구문입니다.
연락처 메모
 note string

연락처를 설명하는 짧은 구입니다. 편의를 위해 사용됩니다. 연락처에 표시되지 않습니다.
연락처 그룹
 groups array of integer

이 연락처가 속할 그룹을 참조하는 정수 ID의 배열입니다.
연락처 태그
 contact_tags array of string

이 연락처에 연결된 태그를 참조하는 GUID 배열입니다.
사용자 지정 필드 ID
 id string

사용자 지정 필드를 참조하는 Guid입니다.
사용자 지정 필드 값
 value string

이 사용자 지정 필드에 대한 이 연락처의 값입니다.
이 연락처와의 현재 대화가 해결되었는지 여부
 is_resolved boolean

이 연락처와의 현재 대화가 해결되었는지 여부를 확인합니다. 이 연락처에서 받은 새 텍스트는 이 false를 설정합니다.

반환

Name 경로 형식 Description
array of object
전화번호
 phone_number string

이 연락처의 전화 번호입니다.
first_name
 first_name string

이 연락처의 이름입니다.
last_name
 last_name string

이 연락처의 성입니다.
display_name
 display_name string

이 연락처의 전체 이름입니다. 연락처를 볼 때 웹앱에 표시되는 기본 이름입니다.
is_suppressed
 is_suppressed boolean

이 연락처와의 대화가 억제되어 수신 시 메시지 큐의 맨 위로 푸시되지 않는지 여부입니다.
is_archived
 is_archived boolean

이 연락처와의 대화가 보관되어 있으므로 대화를 쿼리할 때(기본적으로) 볼 수 없는지 여부입니다.
is_blocked
 is_blocked boolean

이 연락처와의 대화가 차단되어 수신되거나 저장되지 않는지 여부입니다.
suppressed_reason
 suppressed_reason string

접촉을 표시하지 않는 이유를 설명하는 구문입니다. is_suppressed false이면 null이 됩니다.
메모
 note string

연락처를 설명하는 짧은 구입니다. 편의를 위해 사용됩니다. 연락처에 표시되지 않습니다.
groups
 groups array of integer

이 연락처가 속한 그룹을 참조하는 정수 ID의 배열입니다.
contact_tags
 contact_tags array of string

이 연락처에 연결된 태그를 참조하는 GUID 배열입니다.
custom_fields
 custom_fields array of object

이 연락처에 대해 정의된 사용자 지정 필드 ID 및 값의 배열입니다.
아이디
 custom_fields.id string

사용자 지정 필드를 참조하는 Guid입니다.
value
 custom_fields.value string

이 사용자 지정 필드에 대한 이 연락처의 값입니다.
is_resolved
 is_resolved boolean

이 연락처와의 대화가 해결되었는지 여부입니다. 이 연락처에서 받은 새 텍스트는 이 false를 설정합니다.
first_contact_utc
 first_contact_utc string

첫 번째 메시지가 이 연락처로 전송된 시기의 타임스탬프입니다.
opted_out_utc
 opted_out_utc string

이 연락처가 메시지 수신을 옵트아웃한 시점의 타임스탬프입니다.
last_msg_sent_utc
 last_msg_sent_utc string

이 연락처에 마지막 메시지를 보낸 시간의 타임스탬프입니다.
last_msg_received_utc
 last_msg_received_utc string

이 연락처에서 마지막 메시지를 받은 시점의 타임스탬프입니다.
total_msgs_sent
 total_msgs_sent integer

이 연락처로 전송된 총 메시지 수입니다.
total_msgs_received
 total_msgs_received integer

이 연락처에서 받은 총 메시지 수입니다.
response_count
 response_count integer

연락처의 총 응답 메시지 수입니다.
date_created_utc
 date_created_utc string

ths 연락처를 만든 시점의 타임스탬프입니다.
last_contact_date_utc
 last_contact_date_utc string

이 연락처에서 마지막 메시지를 보내거나 받은 시기의 타임스탬프입니다.
message_id
 last_message.message_id string

메시지의 ID입니다. 이 값은 각 메시지에 대해 고유합니다.
body
 last_message.body string

이 메시지의 내용입니다.
message_direction
 last_message.message_direction string

이 메시지가 연락처에서 수신되었는지 또는 보낸 것인지를 나타내는 R 또는 S의 단수 문자입니다.
response_by_username
 last_message.response_by_username string

이 사용자에게 마지막으로 메시지를 보낸 텍스트 요청 사용자의 사용자 이름입니다.
message_timestamp_utc
 last_message.message_timestamp_utc string

텍스트 요청에서 메시지를 보내거나 받은 시기의 타임스탬프입니다.
delivery_status
 last_message.delivery_status string

이 메시지의 현재 상태입니다. 'send', 'delivered', 'error' 또는 'send'일 수 있습니다.
delivery_error
 last_message.delivery_error string

이 메시지가 배달되지 않는 오류가 발생했습니다. delivery_status 'error'가 아니면 이 값은 null이 됩니다.
mms_media
 last_message.mms_media array of string

이 메시지의 첨부 파일을 가리키는 URL 목록입니다. 모든 URL은 텍스트 요청 생성 URL입니다.

연락처 만들기 또는 업데이트

작업 ID:
CreateContact

연락처를 만들거나 업데이트합니다(지정된 전화 번호가 이미 있는지 여부에 따라 다름).

매개 변수

Name 키 필수 형식 Description
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.
연락처 전화 번호
 phone_number True string

만들거나 업데이트할 연락처의 전화 번호입니다.
연락처의 이름
 first_name string

연락처의 새 이름입니다.
연락처의 성
 last_name string

연락처의 새 성입니다.
연락처의 전체 이름
 display_name string

연락처의 새 전체 이름입니다. 연락처를 볼 때 웹앱에 표시되는 기본 이름입니다.
이 연락처의 메시지가 표시되지 않는지 여부
 is_suppressed boolean

이 연락처와의 대화가 표시되지 않도록 하여 수신 시 메시지 큐의 맨 위로 푸시되지 않는지 여부를 결정합니다.
이 연락처의 메시지가 보관되는지 여부
 is_archived boolean

이 연락처와의 대화가 보관되는지 여부를 결정하므로 대화를 쿼리할 때(기본적으로) 볼 수 없습니다.
이 연락처의 메시지가 차단되는지 여부
 is_blocked boolean

이 연락처와의 대화가 차단되어 수신되거나 저장되지 않는지 여부를 결정합니다.
이 연락처를 표시하지 않는 이유
 suppressed_reason string

접촉을 표시하지 않는 이유를 설명하는 구문입니다.
연락처 메모
 note string

연락처를 설명하는 짧은 구입니다. 편의를 위해 사용됩니다. 연락처에 표시되지 않습니다.
연락처 그룹
 groups array of integer

이 연락처가 속할 그룹을 참조하는 정수 ID의 배열입니다.
연락처 태그
 contact_tags array of string

이 연락처에 연결된 태그를 참조하는 GUID 배열입니다.
사용자 지정 필드 ID
 id string

사용자 지정 필드를 참조하는 Guid입니다.
사용자 지정 필드 값
 value string

이 사용자 지정 필드에 대한 이 연락처의 값입니다.
이 연락처와의 현재 대화가 해결되었는지 여부
 is_resolved boolean

이 연락처와의 현재 대화가 해결되었는지 여부를 확인합니다. 이 연락처에서 받은 새 텍스트는 이 false를 설정합니다.

반환

Name 경로 형식 Description
전화번호
 phone_number string

이 연락처의 전화 번호입니다.
first_name
 first_name string

이 연락처의 이름입니다.
last_name
 last_name string

이 연락처의 성입니다.
display_name
 display_name string

이 연락처의 전체 이름입니다. 연락처를 볼 때 웹앱에 표시되는 기본 이름입니다.
is_suppressed
 is_suppressed boolean

이 연락처와의 대화가 억제되어 수신 시 메시지 큐의 맨 위로 푸시되지 않는지 여부입니다.
is_archived
 is_archived boolean

이 연락처와의 대화가 보관되어 있으므로 대화를 쿼리할 때(기본적으로) 볼 수 없는지 여부입니다.
is_blocked
 is_blocked boolean

이 연락처와의 대화가 차단되어 수신되거나 저장되지 않는지 여부입니다.
suppressed_reason
 suppressed_reason string

접촉을 표시하지 않는 이유를 설명하는 구문입니다. is_suppressed false이면 null이 됩니다.
메모
 note string

연락처를 설명하는 짧은 구입니다. 편의를 위해 사용됩니다. 연락처에 표시되지 않습니다.
groups
 groups array of integer

이 연락처가 속한 그룹을 참조하는 정수 ID의 배열입니다.
contact_tags
 contact_tags array of string

이 연락처에 연결된 태그를 참조하는 GUID 배열입니다.
custom_fields
 custom_fields array of object

이 연락처에 대해 정의된 사용자 지정 필드 ID 및 값의 배열입니다.
아이디
 custom_fields.id string

사용자 지정 필드를 참조하는 Guid입니다.
value
 custom_fields.value string

이 사용자 지정 필드에 대한 이 연락처의 값입니다.
is_resolved
 is_resolved boolean

이 연락처와의 대화가 해결되었는지 여부입니다. 이 연락처에서 받은 새 텍스트는 이 false를 설정합니다.
first_contact_utc
 first_contact_utc string

첫 번째 메시지가 이 연락처로 전송된 시기의 타임스탬프입니다.
opted_out_utc
 opted_out_utc string

이 연락처가 메시지 수신을 옵트아웃한 시점의 타임스탬프입니다.
last_msg_sent_utc
 last_msg_sent_utc string

이 연락처에 마지막 메시지를 보낸 시간의 타임스탬프입니다.
last_msg_received_utc
 last_msg_received_utc string

이 연락처에서 마지막 메시지를 받은 시점의 타임스탬프입니다.
total_msgs_sent
 total_msgs_sent integer

이 연락처로 전송된 총 메시지 수입니다.
total_msgs_received
 total_msgs_received integer

이 연락처에서 받은 총 메시지 수입니다.
response_count
 response_count integer

연락처의 총 응답 메시지 수입니다.
date_created_utc
 date_created_utc string

ths 연락처를 만든 시점의 타임스탬프입니다.
last_contact_date_utc
 last_contact_date_utc string

이 연락처에서 마지막 메시지를 보내거나 받은 시기의 타임스탬프입니다.
message_id
 last_message.message_id string

메시지의 ID입니다. 이 값은 각 메시지에 대해 고유합니다.
body
 last_message.body string

이 메시지의 내용입니다.
message_direction
 last_message.message_direction string

이 메시지가 연락처에서 수신되었는지 또는 보낸 것인지를 나타내는 R 또는 S의 단수 문자입니다.
response_by_username
 last_message.response_by_username string

이 사용자에게 마지막으로 메시지를 보낸 텍스트 요청 사용자의 사용자 이름입니다.
message_timestamp_utc
 last_message.message_timestamp_utc string

텍스트 요청에서 메시지를 보내거나 받은 시기의 타임스탬프입니다.
delivery_status
 last_message.delivery_status string

이 메시지의 현재 상태입니다. 'send', 'delivered', 'error' 또는 'send'일 수 있습니다.
delivery_error
 last_message.delivery_error string

이 메시지가 배달되지 않는 오류가 발생했습니다. delivery_status 'error'가 아니면 이 값은 null이 됩니다.
mms_media
 last_message.mms_media array of string

이 메시지의 첨부 파일을 가리키는 URL 목록입니다. 모든 URL은 텍스트 요청 생성 URL입니다.

이 대시보드에 대한 모든 대화를 가져옵니다.

작업 ID:
GetConversations

이 대시보드에 대한 모든 대화를 가져오고 각 대화의 마지막 메시지에 대한 정보를 포함합니다.

매개 변수

Name 키 필수 형식 Description
연락처 태그
 tags string

대화를 필터링할 태그를 참조하는 쉼표로 구분된 guid 목록입니다.
확인된 대화만 표시할지 여부
 show_unresolved_only string

대화가 확인된 연락처만 검색할지 여부입니다. 이 값이 false이면 해결된 대화와 해결되지 않은 대화가 모두 표시됩니다.
보관된 대화를 포함할지 여부
 include_archived string

보관된 연락처와의 대화를 포함할지 여부입니다.
전화 번호 및 연락처 이름을 기준으로 필터링할 용어
 search string

전화 번호 또는 표시 이름을 기준으로 대화를 필터링하는 검색 용어입니다. 검색 용어가 전체 이름 또는 전화 번호보다 작은 경우 검색은 부분적으로 일치하는 모든 대화를 반환합니다.
가져올 번호 페이지
 page integer

가져올 엔터티의 페이지입니다. 값을 가져올 때 페이지당 최대 크기가 page_size 정의됩니다. 페이지가 마지막 페이지보다 크면 빈 배열이 반환됩니다.
페이지당 가져올 각 엔터티의 양
 page_size integer

가져올 각 페이지의 크기입니다. 값을 가져올 때 페이지 매개 변수에서 수행된 후속 페이지에 액세스하는 페이지당 최대 크기입니다.
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.

반환

Name 경로 형식 Description
page
 meta.page integer

받은 엔터티 페이지입니다. 이 페이지의 엔터티 양은 page_size 정의됩니다.
page_size
 meta.page_size integer

이 페이지에서 받은 엔터티 수입니다.
total_items
 meta.total_items integer

페이지 크기 또는 수에 관계없이 데이터베이스에서 사용할 수 있는 엔터티 수입니다. 다른 페이지를 보려면 요청의 페이지 번호를 변경합니다.
items
 items array of object

텍스트 요청에서 받은 대화 엔터티 목록입니다.
전화번호
 items.phone_number string

연락처의 전화 번호입니다.
message_id
 items.last_message.message_id string

메시지의 ID입니다. 이 값은 각 메시지에 대해 고유합니다.
body
 items.last_message.body string

이 메시지의 내용입니다.
message_direction
 items.last_message.message_direction string

이 메시지가 연락처에서 수신되었는지 또는 보낸 것인지를 나타내는 R 또는 S의 단수 문자입니다.
response_by_username
 items.last_message.response_by_username string

이 사용자에게 마지막으로 메시지를 보낸 텍스트 요청 사용자의 사용자 이름입니다.
message_timestamp_utc
 items.last_message.message_timestamp_utc string

텍스트 요청에서 메시지를 보내거나 받은 시기의 타임스탬프입니다.
delivery_status
 items.last_message.delivery_status string

이 메시지의 현재 상태입니다. 'send', 'delivered', 'error' 또는 'send'일 수 있습니다.
delivery_error
 items.last_message.delivery_error string

이 메시지가 배달되지 않는 오류가 발생했습니다. delivery_status 'error'가 아니면 이 값은 null이 됩니다.
mms_media
 items.last_message.mms_media array of string

이 메시지의 첨부 파일을 가리키는 URL 목록입니다. 모든 URL은 텍스트 요청 생성 URL입니다.

이 특정 대시보드에 대한 정보 가져오기

작업 ID:
GetDashboard

대시보드의 이름과 휴대폰을 반환합니다.

매개 변수

Name 키 필수 형식 Description
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.

반환

Name 경로 형식 Description
아이디
 id integer

대시보드의 숫자 ID입니다.
이름
 name string

대시보드의 이름입니다.
phone
 phone string

이 대시보드와 연결된 문자 메시지 번호입니다.

지정된 ID로 그룹을 업데이트합니다.

작업 ID:
UpdateGroup

그룹의 숫자 ID를 사용하여 그룹의 이름을 업데이트합니다. 전달된 그룹 ID가 없으면 호출이 실패합니다.

매개 변수

Name 키 필수 형식 Description
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.
그룹의 ID
 group_id True integer

업데이트할 그룹의 숫자 ID입니다.
그룹 이름
 name string

그룹의 새 이름입니다.
그룹 메모
 notes string

그룹을 설명하는 짧은 구입니다. 편의를 위해 사용됩니다.

반환

Name 경로 형식 Description
아이디
 id integer

그룹의 숫자 ID입니다.
group_member_count
 group_member_count integer

그룹의 멤버 수입니다.
is_keyword
 is_keyword boolean

이 그룹은 키워드 그룹입니다. 이러한 그룹은 사용자가 키워드를 설정할 때 자동으로 생성됩니다. 연락처는 등록할 때 자동으로 추가됩니다.
이름
 name string

이 그룹의 이름입니다.
메모
 notes string

이 그룹에 대한 모든 참고 사항입니다.
last_message_sent_utc
 last_message_sent_utc string

이 그룹에 대한 마지막 그룹 메시지를 보낸 시기의 타임스탬프입니다.

지정된 ID를 사용하여 결제를 가져옵니다.

작업 ID:
GetPayment

지정된 ID를 사용하여 결제를 가져옵니다.

매개 변수

Name 키 필수 형식 Description
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.
결제 ID
 payment_id True integer

가져올 결제의 숫자 ID입니다.

반환

Name 경로 형식 Description
payment_id
 payment_id integer

결제의 숫자 ID입니다.
request_date
 request_date string

이 결제의 초기 메시지가 전송될 큐에 대기된 시점의 타임스탬프입니다.
수령인
 recipient string

결제 받는 사람의 이름입니다. 연락처에 전화 번호와 연결된 이름이 없는 경우 null일 수 있습니다.
description
 description string

지불에 대한 설명입니다. 연락처에 표시되지 않습니다. 내부 사용자가 결제에 대한 컨텍스트에만 사용됩니다.
customer_phone
 customer_phone string

이 결제를 보낼 연락처의 전화 번호입니다.
amount_requested
 amount_requested float

이 지불에서 요청한 달러 금액입니다.
is_past_due
 is_past_due boolean

이 지불이 요청 날짜를 지났는지 여부입니다.
reminder_was_sent
 reminder_was_sent boolean

이 결제를 위해 텍스트 미리 알림이 이미 전송되었는지 여부입니다.
transaction_status
 transaction_status string

인증에서 트랜잭션의 상태입니다. 이 값은 알 수 없음으로 시작합니다.
textrequest_payment_status
 textrequest_payment_status string

텍스트 요청의 트랜잭션 상태입니다. 텍스트 요청 앱의 결제 페이지에 표시되는 상태를 나타냅니다. Sent로 시작합니다.
reference_number
 reference_number string

신속하게 결제를 찾는 데 사용할 수 있는 결제가 생성될 때 정의된 사용자 정의 ID입니다. 참조 번호는 고유하지 않습니다. 많은 결제에 동일한 참조가 있을 수 있습니다.

지정된 ID를 사용하여 그룹을 삭제합니다.

작업 ID:
DeleteGroup

지정된 ID를 사용하여 그룹을 삭제합니다. 그룹의 구성원인 연락처가 있는 경우에도 성공합니다(연락처는 삭제되지 않음).

매개 변수

Name 키 필수 형식 Description
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.
그룹의 ID
 group_id True integer

삭제할 그룹의 숫자 ID입니다.

반환

response
string

지정된 결제를 취소합니다.

작업 ID:
CancelPayment

지정된 결제를 취소하고 결제가 취소되었음을 사용자에게 문자 메시지로 전달합니다. 결제는 편집할 수 없으므로 새 결제를 취소하고 발행하는 것이 결제를 수정하는 가장 좋은 방법입니다.

매개 변수

Name 키 필수 형식 Description
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.
결제 ID
 payment_id True integer

업데이트할 결제의 숫자 ID입니다.

반환

Name 경로 형식 Description
payment_id
 payment_id integer

결제의 숫자 ID입니다.
request_date
 request_date string

이 결제의 초기 메시지가 전송될 큐에 대기된 시점의 타임스탬프입니다.
수령인
 recipient string

결제 받는 사람의 이름입니다. 연락처에 전화 번호와 연결된 이름이 없는 경우 null일 수 있습니다.
description
 description string

지불에 대한 설명입니다. 연락처에 표시되지 않습니다. 내부 사용자가 결제에 대한 컨텍스트에만 사용됩니다.
customer_phone
 customer_phone string

이 결제를 보낼 연락처의 전화 번호입니다.
amount_requested
 amount_requested float

이 지불에서 요청한 달러 금액입니다.
is_past_due
 is_past_due boolean

이 지불이 요청 날짜를 지났는지 여부입니다.
reminder_was_sent
 reminder_was_sent boolean

이 결제를 위해 텍스트 미리 알림이 이미 전송되었는지 여부입니다.
transaction_status
 transaction_status string

인증에서 트랜잭션의 상태입니다. 이 값은 알 수 없음으로 시작합니다.
textrequest_payment_status
 textrequest_payment_status string

텍스트 요청의 트랜잭션 상태입니다. 텍스트 요청 앱의 결제 페이지에 표시되는 상태를 나타냅니다. Sent로 시작합니다.
reference_number
 reference_number string

신속하게 결제를 찾는 데 사용할 수 있는 결제가 생성될 때 정의된 사용자 정의 ID입니다. 참조 번호는 고유하지 않습니다. 많은 결제에 동일한 참조가 있을 수 있습니다.

지정된 대시보드를 삭제합니다.

작업 ID:
DeleteDashboard

지정된 대시보드를 삭제합니다.

매개 변수

Name 키 필수 형식 Description
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.

반환

response
string

지정된 이름 및 전화 번호를 사용하여 새 대시보드 만들기

작업 ID:
CreateDashboard

계정에 새 대시보드를 만듭니다. 대시보드가 만들어지면 관리자에게 변경 내용에 대한 전자 메일을 보내 사용자 할당을 시작할 수 있습니다. 이 엔드포인트는 프로비전된 숫자에 대한 대시보드를 만들 수 있습니다. GET /dashboards/provisioning을 사용하여 특정 지역 코드에서 프로비전된 숫자를 검색할 수 있습니다. 전화 번호가 이미 사용 중인 경우 잘못된 요청 예외가 throw됩니다.

매개 변수

Name 키 필수 형식 Description
이름
 name string

대시보드의 이름입니다.
phone
 phone string

이 대시보드와 연결된 문자 메시지 번호입니다.

반환

Name 경로 형식 Description
아이디
 id integer

대시보드의 숫자 ID입니다.
이름
 name string

대시보드의 이름입니다.
phone
 phone string

이 대시보드와 연결된 문자 메시지 번호입니다.

지정된 전화 번호가 있는 연락처를 가져옵니다.

작업 ID:
GetContactByPhoneNumber

지정된 전화 번호가 있는 연락처를 가져옵니다.

매개 변수

Name 키 필수 형식 Description
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.
연락처의 전화 번호
 phone_number True string

가져올 연락처의 전화 번호입니다.

반환

Name 경로 형식 Description
전화번호
 phone_number string

이 연락처의 전화 번호입니다.
first_name
 first_name string

이 연락처의 이름입니다.
last_name
 last_name string

이 연락처의 성입니다.
display_name
 display_name string

이 연락처의 전체 이름입니다. 연락처를 볼 때 웹앱에 표시되는 기본 이름입니다.
is_suppressed
 is_suppressed boolean

이 연락처와의 대화가 억제되어 수신 시 메시지 큐의 맨 위로 푸시되지 않는지 여부입니다.
is_archived
 is_archived boolean

이 연락처와의 대화가 보관되어 있으므로 대화를 쿼리할 때(기본적으로) 볼 수 없는지 여부입니다.
is_blocked
 is_blocked boolean

이 연락처와의 대화가 차단되어 수신되거나 저장되지 않는지 여부입니다.
suppressed_reason
 suppressed_reason string

접촉을 표시하지 않는 이유를 설명하는 구문입니다. is_suppressed false이면 null이 됩니다.
메모
 note string

연락처를 설명하는 짧은 구입니다. 편의를 위해 사용됩니다. 연락처에 표시되지 않습니다.
groups
 groups array of integer

이 연락처가 속한 그룹을 참조하는 정수 ID의 배열입니다.
contact_tags
 contact_tags array of string

이 연락처에 연결된 태그를 참조하는 GUID 배열입니다.
custom_fields
 custom_fields array of object

이 연락처에 대해 정의된 사용자 지정 필드 ID 및 값의 배열입니다.
아이디
 custom_fields.id string

사용자 지정 필드를 참조하는 Guid입니다.
value
 custom_fields.value string

이 사용자 지정 필드에 대한 이 연락처의 값입니다.
is_resolved
 is_resolved boolean

이 연락처와의 대화가 해결되었는지 여부입니다. 이 연락처에서 받은 새 텍스트는 이 false를 설정합니다.
first_contact_utc
 first_contact_utc string

첫 번째 메시지가 이 연락처로 전송된 시기의 타임스탬프입니다.
opted_out_utc
 opted_out_utc string

이 연락처가 메시지 수신을 옵트아웃한 시점의 타임스탬프입니다.
last_msg_sent_utc
 last_msg_sent_utc string

이 연락처에 마지막 메시지를 보낸 시간의 타임스탬프입니다.
last_msg_received_utc
 last_msg_received_utc string

이 연락처에서 마지막 메시지를 받은 시점의 타임스탬프입니다.
total_msgs_sent
 total_msgs_sent integer

이 연락처로 전송된 총 메시지 수입니다.
total_msgs_received
 total_msgs_received integer

이 연락처에서 받은 총 메시지 수입니다.
response_count
 response_count integer

연락처의 총 응답 메시지 수입니다.
date_created_utc
 date_created_utc string

ths 연락처를 만든 시기의 타임스탬프입니다.
last_contact_date_utc
 last_contact_date_utc string

이 연락처에서 마지막 메시지를 보내거나 받은 시기의 타임스탬프입니다.
message_id
 last_message.message_id string

메시지의 ID입니다. 이 값은 각 메시지에 대해 고유합니다.
body
 last_message.body string

이 메시지의 내용입니다.
message_direction
 last_message.message_direction string

이 메시지가 연락처에서 수신되었는지 또는 보낸 것인지를 나타내는 R 또는 S의 단수 문자입니다.
response_by_username
 last_message.response_by_username string

이 사용자에게 마지막으로 메시지를 보낸 텍스트 요청 사용자의 사용자 이름입니다.
message_timestamp_utc
 last_message.message_timestamp_utc string

텍스트 요청에서 메시지를 보내거나 받은 시기의 타임스탬프입니다.
delivery_status
 last_message.delivery_status string

이 메시지의 현재 상태입니다. 'send', 'delivered', 'error' 또는 'send'일 수 있습니다.
delivery_error
 last_message.delivery_error string

이 메시지가 배달되지 않는 오류가 발생했습니다. delivery_status 'error'가 아니면 이 값은 null이 됩니다.
mms_media
 last_message.mms_media array of string

이 메시지의 첨부 파일을 가리키는 URL 목록입니다. 모든 URL은 텍스트 요청 생성 URL입니다.

지정된 전화 번호가 있는 연락처를 삭제합니다.

작업 ID:
DeleteContact

지정된 전화 번호가 있는 연락처를 삭제합니다.

매개 변수

Name 키 필수 형식 Description
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.
연락처 전화 번호
 phone_number True string

삭제할 연락처의 전화 번호입니다.

반환

response
string

지정된 전화 번호로 연락처에 메시지 보내기

작업 ID:
SendMessageByPhoneNumber

메시지를 보냅니다(지정된 전화 번호에 메시지 기록이 없는 경우 새 대화 시작).

매개 변수

Name 키 필수 형식 Description
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.
메시지로 전화 번호
 phone_number True string

메시지를 보낼 연락처의 전화 번호입니다.
메시지 본문
 body string

보낼 메시지의 내용입니다.
보낸 사람의 이름
 sender_name string

메시지 보낸 사람의 이름입니다. 이 메시지는 이 메시지를 검색할 때 TextRequest 웹앱 및 api에 표시됩니다.
메시지 상태가 업데이트되는 시기에 대한 콜백 URL
 status_callback string

이 메시지의 상태가 배달되지 않은 상태에서 전송됨(또는 오류)으로 갈 때마다 POST 명령으로 적중할 웹앱의 URL입니다.
이 메시지에 위치 요청이 포함된 경우의 콜백 URL
 location_callback string

사용자가 보낸 사람과 자신의 위치 공유를 액세스하고 승인할 때 POST 명령으로 적중할 위치 콜백 URL입니다. 링크를 포함하려면 메시지 본문에 [위치 요청]을 추가합니다. 이 콜백은 위치 요청에 필요하지 않지만 API에 유용할 수 있습니다.
이 메시지에 대한 MMS 미디어 첨부 파일
 mms_media array of string

이 메시지에 대한 MMS 미디어 첨부 파일의 배열입니다. 첨부 파일은 게시물 /mms 엔드포인트에서 받은 URL이어야 합니다(이 커넥터에 포함되지 않음). 외부 첨부 파일 링크는 허용되지 않습니다.

반환

Name 경로 형식 Description
message_id
 message_id string

메시지의 ID입니다. 이 값은 각 메시지에 대해 고유합니다.
body
 body string

이 메시지의 내용입니다.
message_direction
 message_direction string

이 메시지가 연락처에서 수신되었는지 또는 보낸 것인지를 나타내는 R 또는 S의 단수 문자입니다.
response_by_username
 response_by_username string

이 사용자에게 마지막으로 메시지를 보낸 텍스트 요청 사용자의 사용자 이름입니다.
message_timestamp_utc
 message_timestamp_utc string

텍스트 요청에서 메시지를 보내거나 받은 시기의 타임스탬프입니다.
delivery_status
 delivery_status string

이 메시지의 현재 상태입니다. 'send', 'delivered', 'error' 또는 'send'일 수 있습니다.
delivery_error
 delivery_error string

이 메시지가 배달되지 않는 오류가 발생했습니다. delivery_status 'error'가 아니면 이 값은 null이 됩니다.
mms_media
 mms_media array of string

이 메시지의 첨부 파일을 가리키는 URL 목록입니다. 모든 URL은 텍스트 요청 생성 URL입니다.

지정된 필터링 조건과 일치하는 모든 연락처 가져오기

작업 ID:
GetContacts

지정된 필터링 조건과 일치하는 모든 연락처를 가져옵니다. 지정된 대시보드만 검색됩니다. 사용할 수 있는 숫자에 대한 계정 수준 검색이 없습니다.

매개 변수

Name 키 필수 형식 Description
검색할 연락처의 전화 번호
 contact_phone_number string

연락처를 필터링할 전화 번호입니다.
'마지막 메시지 전송 시간 전' 검색 타임스탬프(UTC 시간)
 last_message_timestamp_before_utc date-time

마지막으로 보내거나 받은 메시지로 연락처를 검색하기 위한 차단 시간입니다. 이 시간 이후에 메시지를 보낸 연락처는 표시되지 않습니다.
'마지막 메시지 전송 시간' 검색 타임스탬프(UTC 시간)
 last_message_timestamp_after_utc date-time

마지막으로 보내거나 받은 메시지로 연락처를 검색하기 위한 차단 시간입니다. 마지막으로 보낸 메시지가 이 시간 이전인 연락처는 표시되지 않습니다.
'전에 만든' 검색 타임스탬프
 contact_created_before date-time

연락처가 만들어진 시점까지의 연락처 검색 차단 시간입니다. 이 시간 이후에 만든 연락처는 표시되지 않습니다.
'만든 후' 검색 타임스탬프
 contact_created_after date-time

연락처가 만들어진 시점까지의 연락처 검색 차단 시간입니다. 이 시간 전에 만든 연락처가 표시되지 않습니다.
대화 상대의 대화 확인 여부
 is_resolved boolean

대화가 확인된 연락처를 검색할지 여부입니다.
연락처 차단 여부
 is_blocked boolean

차단된 연락처를 검색할지 여부입니다.
연락처 보관 여부
 is_archived boolean

보관된 연락처를 검색할지 여부입니다.
연락처를 표시하지 않는지 여부
 is_suppressed boolean

표시되지 않은 연락처를 검색할지 여부입니다.
연락처가 옵트아웃되었는지 여부
 has_opted_out boolean

텍스트 수신을 옵트아웃한 연락처를 검색할지 여부입니다.
'마지막 메시지 전송 시간 전' 검색 타임스탬프
 last_message_sent_before date-time

고객에게 마지막 메시지를 보낸 시점까지 연락처를 검색하기 위한 차단 시간입니다. 이 시간 이후에 메시지를 보낸 연락처는 표시되지 않습니다. 타임스탬프를 현지 시간으로 사용합니다. UTC 시간으로 타임스탬프를 기준으로 필터링하려면 last_message_sent_before_utc
'마지막 메시지 전송 시간 후' 검색 타임스탬프
 last_message_sent_after date-time

고객에게 마지막 메시지를 보낸 시점까지 연락처를 검색하기 위한 차단 시간입니다. 마지막으로 보낸 메시지가 이 시간 이전인 연락처는 표시되지 않습니다. 타임스탬프를 현지 시간으로 사용합니다. UTC 시간으로 타임스탬프를 기준으로 필터링하려면 last_message_sent_after_utc
'마지막으로 받은 메시지-시간' 검색 타임스탬프
 last_message_received_before date-time

고객으로부터 받은 마지막 메시지로 연락처를 검색하기 위한 차단 시간입니다. 이 시간 이후에 메시지를 받은 연락처는 표시되지 않습니다. 타임스탬프를 현지 시간으로 사용합니다. UTC 시간으로 타임스탬프를 기준으로 필터링하려면 last_message_sent_before_utc
'마지막 메시지-받은 시간' 검색 타임스탬프
 last_message_received_after date-time

고객으로부터 받은 마지막 메시지로 연락처를 검색하기 위한 차단 시간입니다. 마지막으로 보낸 메시지가 이 시간 이전인 연락처는 표시되지 않습니다. 타임스탬프를 현지 시간으로 사용합니다. UTC 시간으로 타임스탬프를 기준으로 필터링하려면 last_message_sent_before_utc
연락처 태그
 tags string

연락처를 필터링하는 태그를 참조하는 쉼표로 구분된 guid 목록입니다.
연락처 그룹
 groups string

연락처를 필터링할 그룹을 참조하는 정수 ID의 쉼표로 구분된 목록입니다.
필터링할 사용자 지정 필드의 ID입니다.
 custom_field_id_1 string

연락처를 필터링할 사용자 지정 필드를 참조하는 Guid입니다.
필터링할 사용자 지정 필드의 값입니다.
 custom_field_value_1 string

연락처를 필터링할 사용자 지정 필드를 참조하는 값입니다.
필터링할 두 번째 사용자 지정 필드의 ID입니다.
 custom_field_id_2 string

연락처를 필터링하는 두 번째 사용자 지정 필드를 참조하는 Guid입니다.
필터링할 두 번째 사용자 지정 필드의 값입니다.
 custom_field_value_2 string

연락처를 필터링할 두 번째 사용자 지정 필드를 참조하는 값입니다.
필터링할 세 번째 사용자 지정 필드의 ID입니다.
 custom_field_id_3 string

연락처를 필터링할 세 번째 사용자 지정 필드를 참조하는 Guid입니다.
필터링할 세 번째 사용자 정의 필드의 값입니다.
 custom_field_value_3 string

연락처를 필터링할 세 번째 사용자 지정 필드를 참조하는 값입니다.
가져올 번호 페이지
 page True integer

가져올 엔터티의 페이지입니다. 값을 가져올 때 페이지당 최대 크기가 page_size 정의됩니다. 페이지가 마지막 페이지보다 크면 빈 배열이 반환됩니다.
페이지당 가져올 각 엔터티의 양
 page_size True integer

가져올 각 페이지의 크기입니다. 값을 가져올 때 페이지 매개 변수에서 수행된 후속 페이지에 액세스하는 페이지당 최대 크기입니다.
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.

반환

Name 경로 형식 Description
page
 meta.page integer

받은 엔터티 페이지입니다. 이 페이지의 엔터티 양은 page_size 정의됩니다.
page_size
 meta.page_size integer

이 페이지에서 받은 엔터티 수입니다.
total_items
 meta.total_items integer

페이지 크기 또는 수에 관계없이 데이터베이스에서 사용할 수 있는 엔터티 수입니다. 다른 페이지를 보려면 요청의 페이지 번호를 변경합니다.
items
 items array of object

텍스트 요청에서 받은 연락처 엔터티 목록입니다.
전화번호
 items.phone_number string

이 연락처의 전화 번호입니다.
first_name
 items.first_name string

이 연락처의 이름입니다.
last_name
 items.last_name string

이 연락처의 성입니다.
display_name
 items.display_name string

이 연락처의 전체 이름입니다. 연락처를 볼 때 웹앱에 표시되는 기본 이름입니다.
is_suppressed
 items.is_suppressed boolean

이 연락처와의 대화가 억제되어 수신 시 메시지 큐의 맨 위로 푸시되지 않는지 여부입니다.
is_archived
 items.is_archived boolean

이 연락처와의 대화가 보관되어 있으므로 대화를 쿼리할 때(기본적으로) 볼 수 없는지 여부입니다.
is_blocked
 items.is_blocked boolean

이 연락처와의 대화가 차단되어 수신되거나 저장되지 않는지 여부입니다.
suppressed_reason
 items.suppressed_reason string

접촉을 표시하지 않는 이유를 설명하는 구문입니다. is_suppressed false이면 null이 됩니다.
메모
 items.note string

연락처를 설명하는 짧은 구입니다. 편의를 위해 사용됩니다. 연락처에 표시되지 않습니다.
groups
 items.groups array of integer

이 연락처가 속한 그룹을 참조하는 정수 ID의 배열입니다.
contact_tags
 items.contact_tags array of string

이 연락처에 연결된 태그를 참조하는 GUID 배열입니다.
custom_fields
 items.custom_fields array of object

이 연락처에 대해 정의된 사용자 지정 필드 ID 및 값의 배열입니다.
아이디
 items.custom_fields.id string

사용자 지정 필드를 참조하는 Guid입니다.
value
 items.custom_fields.value string

이 사용자 지정 필드에 대한 이 연락처의 값입니다.
is_resolved
 items.is_resolved boolean

이 연락처와의 대화가 해결되었는지 여부입니다. 이 연락처에서 받은 새 텍스트는 이 false를 설정합니다.
first_contact_utc
 items.first_contact_utc string

첫 번째 메시지가 이 연락처로 전송된 시기의 타임스탬프입니다.
opted_out_utc
 items.opted_out_utc string

이 연락처가 메시지 수신을 옵트아웃한 시점의 타임스탬프입니다.
last_msg_sent_utc
 items.last_msg_sent_utc string

이 연락처에 마지막 메시지를 보낸 시간의 타임스탬프입니다.
last_msg_received_utc
 items.last_msg_received_utc string

이 연락처에서 마지막 메시지를 받은 시점의 타임스탬프입니다.
total_msgs_sent
 items.total_msgs_sent integer

이 연락처로 전송된 총 메시지 수입니다.
total_msgs_received
 items.total_msgs_received integer

이 연락처에서 받은 총 메시지 수입니다.
response_count
 items.response_count integer

연락처의 총 응답 메시지 수입니다.
date_created_utc
 items.date_created_utc string

ths 연락처를 만든 시점의 타임스탬프입니다.
last_contact_date_utc
 items.last_contact_date_utc string

이 연락처에서 마지막 메시지를 보내거나 받은 시기의 타임스탬프입니다.
message_id
 items.last_message.message_id string

메시지의 ID입니다. 이 값은 각 메시지에 대해 고유합니다.
body
 items.last_message.body string

이 메시지의 내용입니다.
message_direction
 items.last_message.message_direction string

이 메시지가 연락처에서 수신되었는지 또는 보낸 것인지를 나타내는 R 또는 S의 단수 문자입니다.
response_by_username
 items.last_message.response_by_username string

이 사용자에게 마지막으로 메시지를 보낸 텍스트 요청 사용자의 사용자 이름입니다.
message_timestamp_utc
 items.last_message.message_timestamp_utc string

텍스트 요청에서 메시지를 보내거나 받은 시기의 타임스탬프입니다.
delivery_status
 items.last_message.delivery_status string

이 메시지의 현재 상태입니다. 'send', 'delivered', 'error' 또는 'send'일 수 있습니다.
delivery_error
 items.last_message.delivery_error string

이 메시지가 배달되지 않는 오류가 발생했습니다. delivery_status 'error'가 아니면 이 값은 null이 됩니다.
mms_media
 items.last_message.mms_media array of string

이 메시지의 첨부 파일을 가리키는 URL 목록입니다. 모든 URL은 텍스트 요청 생성 URL입니다.

특정 대시보드의 이름 업데이트

작업 ID:
UpdateDashboardsName

대시보드를 업데이트합니다. 대시보드의 전화 번호는 변경되지 않습니다. 다른 대시보드의 연락처가 있는 새 번호를 원하는 경우 POST를 사용하여 새 대시보드를 만들고 대량 내보내기/가져오기를 사용하여 연락처를 추가해야 합니다.

매개 변수

Name 키 필수 형식 Description
이 호출을 수행할 대시보드의 ID
 dashboard_id True integer

작업할 전화 번호 대시보드입니다. 단일 계정에는 여러 대시보드가 있을 수 있으며, 고객에 대해 서로 다른 전화선을 나타냅니다.
대시보드 이름
 name string

대시보드의 새 이름입니다.

반환

Name 경로 형식 Description
아이디
 id integer

대시보드의 숫자 ID입니다.
이름
 name string

대시보드의 이름입니다.
phone
 phone string

이 대시보드와 연결된 문자 메시지 번호입니다.

트리거

텍스트를 보내거나 받을 때 트리거

텍스트를 보내거나 받을 때 트리거

텍스트를 보내거나 받을 때 트리거

작업 ID:
TextingWebhook

텍스트를 보내거나 받을 때 트리거

매개 변수

Name 키 필수 형식 Description
트리거에서 이벤트를 수신 대기하는 대시보드
 dashboard_id True string

트리거를 추가할 대시보드의 ID
이벤트
 event True string

이벤트

반환

Name 경로 형식 Description
메시지 고유 ID
 messageUniqueIdentifier string

messageUniqueIdentifier
계정 ID
 account.id integer

아이디
대화 ID
 yourPhoneNumber.id integer

아이디
대시보드 이름
 yourPhoneNumber.description string

description
대시보드 전화 번호
 yourPhoneNumber.phoneNumber string

전화번호
대시보드 ID
 conversation.id integer

아이디
date
 conversation.date string

date
연락처 전화 번호
 conversation.consumerPhoneNumber string

consumerPhoneNumber
messageDirection
 conversation.messageDirection string

messageDirection
message
 conversation.message string

message
numSegments
 conversation.numSegments integer

numSegments
status
 conversation.status string

status
클레임한 대화
 conversation.claimedBy string

claimedBy
연락처 표시 이름
 conversation.consumerFriendlyName string

consumerFriendlyName

정의

문자열

기본 데이터 형식 'string'입니다.