알파 이름 요청

알파 이름(메시지 발신자로 사용되는 확인된 비즈니스 이름)을 생성하고 나열하기 위한 API 경로입니다.

1. 조직 알파 이름 만들기

이 POST 요청은 조직과 관련된 새로운 알파 이름을 생성하는 데 사용됩니다. 요청에는 헤더에 조직 인증 키가 필요합니다.

요청 - URL: https://restapi.smsbat.com/organizations/alpha_name - 방법: POST - 헤더: - 수락: 애플리케이션/json - X-Authorization-Key: {organization_token} (사용자 프로필 섹션에서 생성됨).

본문:

{
  "name": "testName",
  "companyCode": "88888888"
}

신체 매개변수: 1. name(문자열): 제안된 알파 이름입니다. - 요구사항: 길이는 12자 미만이어야 합니다. 2. companyCode(문자열): Alphaname(우크라이나의 경우 ERPOU/IPN)과 연결된 회사 등록 코드입니다.

가능한 응답: - 200 OK: 조정/생성을 위해 알파 이름이 성공적으로 전송되었습니다. - 400 잘못된 요청: 유효성 검사 오류(예: 이름이 너무 깁니다). - 401 승인되지 않음: 'X-Authorization-Key'가 잘못되었거나 누락되었습니다.

---

2. AlphaName 목록 가져오기

현재 조정 상태를 포함하여 알파 이름의 최신 목록을 검색합니다.

요청 - URL: https://restapi.smsbat.com/organizations/alpha_name/list - 방법: GET - 헤더: - X-인증 키: {organization_token}

응답(200 OK):

[
    {
        "name": "test1",
        "status": "Pending Approval",
        "statusCode": "PA",
        "statusUpdateDate": "2024-07-24T16:34:40.137432Z"
    },
    {
        "name": "test2",
        "status": "Approved",
        "statusCode": "A",
        "statusUpdateDate": "2024-07-24T15:46:50.494443Z"
    }
]

알파 이름 상태(statusCode): - PA - 승인 보류 중 - A - 승인됨 - D - 거절됨