메인 콘텐츠로 건너뛰기

사용자 단어 등록

사용자 등록 단어의 가져오기, 내보내기를 수행하는 API입니다.

사용자 등록 단어 가져오기​

등록된 단어 목록을 JSON 형식으로 가져올 수 있습니다.

엔드포인트​

GET https://acp-api.amivoice.com/profilewords/<dgn>/<pid>?adf=<adf>

인증​

APPKEY는 Authorization 헤더에 지정해 주십시오.

Authorization: Bearer {APPKEY}

요청 파라미터​

파라미터 이름
파라미터 이름
비고
dgn연결 엔진 이름-a-general 등의 연결 엔진 이름을 지정합니다. 지정할 수 있는 값은 음성 인식 엔진 목록을 참조해 주십시오. 경로 파라미터로 설정합니다.
pid프로파일 ID임의의 문자열. 경로 파라미터로 설정합니다.
adf음성 데이터 형식16k 또는 8k 중 하나를 지정합니다. 지정하지 않으면 16k가 됩니다. 음성 인식 엔진에 따라 여러 샘플링 레이트를 지원하지만, 단어 등록은 8k, 16k를 각각 다른 엔진으로 취급하기 때문에 둘 중 하나를 지정해야 합니다. 쿼리 파라미터로 설정합니다.

프로파일 목록 취득​

프로파일 목록을 JSON 형식으로 취득할 수 있습니다.

엔드포인트​

GET https://acp-api.amivoice.com/profilewords/<dgn>/

인증​

APPKEY는 Authorization 헤더에 지정해 주십시오.

Authorization: Bearer {APPKEY}

요청 파라미터​

파라미터 이름
파라미터 이름
비고
dgn연결 엔진 이름-a-general 등의 연결 엔진 이름을 지정합니다. 지정할 수 있는 값은 음성 인식 엔진 목록을 참조해 주십시오. 경로 파라미터로 설정합니다.
adf음성 데이터 형식16k 또는 8k 중 하나를 지정합니다. 지정하지 않으면 16k가 됩니다. 음성 인식 엔진에 따라 여러 샘플링 레이트를 지원하지만, 단어 등록은 8k, 16k를 각각 다른 엔진으로 취급하므로 둘 중 하나를 지정해야 합니다. 쿼리 파라미터로 설정합니다.
경고

"프로파일 목록 취득"은 현재 지원되지 않습니다. 가까운 시일 내에 지원 예정입니다.

사용자 등록 단어 등록​

지정한 음성 인식 엔진과 프로파일 ID의 사용자 등록 단어를 교체할 수 있습니다.

엔드포인트​

POST https://acp-api.amivoice.com/profilewords/<dgn>/<pid>?adf=<adf>

인증​

APPKEY는 Authorization 헤더에 지정해 주십시오.

Authorization: Bearer {APPKEY}

요청 파라미터​

파라미터 이름
파라미터 이름
비고
dgn연결 엔진 이름-a-general 등의 연결 엔진 이름을 지정합니다. 지정할 수 있는 값은 음성 인식 엔진 목록을 참조해 주십시오.경로 파라미터로 설정합니다.
pid프로파일 ID임의의 문자열.경로 파라미터로 설정합니다.
adf음성 데이터 형식16k 또는 8k 중 하나를 지정합니다. 지정하지 않으면 16k가 됩니다. 음성 인식 엔진에 따라 여러 샘플링 레이트를 지원하지만, 단어 등록은 8k, 16k를 각각 다른 엔진으로 취급하기 때문에 둘 중 하나를 지정해야 합니다.쿼리 파라미터로 설정합니다.

컨텐츠 타입

Content-Type: application/json

요청 본문

필드명
설명
비고
profilewords단어 등록 정보등록하고 싶은 단어를 배열 형식으로 지정합니다
profilewords[].written표기단어의 표기를 지정합니다
profilewords[].spoken읽기단어의 읽기를 지정합니다
profilewords[].classname클래스명클래스명을 지정합니다. 설정하지 않을 때는 생략가능합니다

예

{
    "profilewords": [
        {
            "written": "AMI",
            "spoken": "あみ"
        },
        {
            "written": "AOI",
            "spoken": "あおい"
        },
        {
            "written": "躑躅森",
            "spoken": "つつじもり",
            "classname": "名前"
        }
    ]
}

응답​

성공 시​

HTTP 상태 코드: 200 OK

응답 본문

필드명
설명
비고
profilewords단어 등록 정보등록된 단어가 배열 형식으로 반환됩니다
profilewords[].written표기단어의 표기가 반환됩니다
profilewords[].spoken읽기단어의 읽기가 반환됩니다
profilewords[].classname클래스명클래스명이 반환됩니다. 설정되지 않았을 때는 생략됩니다

예

{
    "profilewords": [
        {
            "written": "AMI",
            "spoken": "あみ"
        },
        {
            "written": "AOI",
            "spoken": "あおい"
        },
        {
            "written": "躑躅森",
            "spoken": "つつじもり",
            "classname": "名前"
        }
    ]
}

실패 시​

HTTP 상태 코드: 200 이외

응답 본문

필드명
설명
비고
code오류 코드오류 유형을 나타내는 코드
message오류 메시지오류 내용의 상세를 설명하는 텍스트

오류 코드와 오류 메시지

HTTP 상태 코드
응답 본문오류 상황
404 Not Found{"code":"?","message":"missing dictation grammar file name"}딕테이션 문법 파일명 <dgn>이 지정되지 않았을 때
404 Not Found{"code":"?","message":"missing profile id"}프로파일 ID <pid>가 지정되지 않았을 때
405 Method Not Allowed{"code":"?","message":"POST method is not allowed"}POST가 지정되었을 때
400 Bad Request{"code":"-","message":"missing request body"}POST 메소드로 요청되었는데 요청 본문이 지정되지 않았을 때
400 Bad Request{"code":"-","message":"invalid request body (<optionalMessage>)"}요청 본문이 JSON으로서 올바르지 않을 때
422 Unprocessable Entity{"code":"-","message":"missing profile words"}요청 본문에 지정된 JSON이 기대한 형식이 아닐 때
422 Unprocessable Entity{"code":"-","message":"invalid written: <written>"}요청 본문에 지정된 JSON 내의 표기/읽기/단어 클래스가 올바르지 않을 때
422 Unprocessable Entity{"code":"-","message":"invalid written: <spoken>"}요청 본문에 지정된 JSON 내의 표기/읽기/단어 클래스가 올바르지 않을 때
422 Unprocessable Entity{"code":"-","message":"invalid written: <className>"}요청 본문에 지정된 JSON 내의 표기/읽기/단어 클래스가 올바르지 않을 때
401 Unauthorized{"code":"-","message":"can't verify service authorization"}APPKEY(서비스 인증 키 문자열)의 인증에 실패했을 때
401 Unauthorized{"code":"-","message":"service authorization has expired: <expirationTime> (<expiresIn>)"}APPKEY(서비스 인증 키 문자열)의 인증에 실패했을 때
500 Internal Server Error{"code":"?","message":"unexpected exception occurred (<optionalMessage>)"}예상치 못한 예외가 발생했을 때

예

{
    "code":"?",
    "message":"missing dictation grammar file name"
}