메시지 폼

사전에 자주 전송하는 메시지 형태를 등록합니다. 통합메시지 전송 시 메시지폼 ID를 입력하여 전송할 수 있습니다.

• 메시지 관련 상세 옵션필드를 모두 사용할 수 있는 전문가 방식 입니다.

• 메시지 내용, 제목, 버튼 등에 치환문구를 활용하여 등록 할 수 있습니다.

• 상세 Response 내용은 코드표를 참조해주시기 바랍니다.

• 메시지 폼에 MMS FileKey, RCS Media 사용 시 유효기간에 유의해 주시기 바랍니다.

• 메시지 폼 등록 후 최대 5분 뒤에 사용 가능합니다.

전송(통합메시지) 발송 시 사용하기 위한 메시지 형식 입니다.

메시지 폼 ID 발송 시 등록된 메시지 순서대로 전송 및 Fallback 처리 됩니다.

메시지 폼 등록

POST /v1/form

Request

Header

Name	Type	Description
Authorization	String	schema + “ “ + token
Content-Type	String	application/json
Accept	String	application/json

Body

Name	Type	Required	Description
messageForm	Object Array	YES	메시지 폼 정보

cURL

curl -X POST https://omni.ibapi.kr/v1/form \
-H "content-type: application/json" \
-H "Accept: application/json" \
-H "Authorization:Bearer 발급받은 토큰" \
-d '{"messageForm":[{"rcs":{"content":{"standalone":{"text":"RCS 메시지 내용"}},"from":"발신번호","formatId":"SS000000"}},{"sms":{"from":"발신번호","text":"SMS 메시지 내용"}}]}'

JAVA

import java.io.*;
import okhttp3.*;
public class Main {
  public static void main(String []args) throws IOException{
    OkHttpClient client = new OkHttpClient().newBuilder()
      .build();
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\"messageForm\":[{\"rcs\":{\"content\":{\"standalone\":{\"text\":\"RCS 메시지 내용\"}},\"from\":\"발신번호\",\"formatId\":\"SS000000\"}},{\"sms\":{\"from\":\"발신번호\",\"text\":\"SMS 메시지 내용\"}}]}");
    Request request = new Request.Builder()
      .url("https://omni.ibapi.kr/v1/form")
      .method("POST", body)
      .addHeader("Content-Type", "application/json")
      .addHeader("Accept", "application/json")
      .addHeader("Authorization", "Bearer 발급받은 토큰")
      .build();
    Response response = client.newCall(request).execute();
    System.out.println(response.body().string());
  }
}

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://omni.ibapi.kr/v1/form"
  method := "POST"

  payload := strings.NewReader(`{"messageForm":[{"rcs":{"content":{"standalone":{"text":"RCS 메시지 내용"}},"from":"발신번호","formatId":"SS000000"}},{"sms":{"from":"발신번호","text":"SMS 메시지 내용"}}]}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Accept", "application/json")
  req.Header.Add("Authorization", "Bearer 발급받은 토큰")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://omni.ibapi.kr/v1/form',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{"messageForm":[{"rcs":{"content":{"standalone":{"text":"RCS 메시지 내용"}},"from":"발신번호","formatId":"SS000000"}},{"sms":{"from":"발신번호","text":"SMS 메시지 내용"}}]}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Accept: application/json',
    'Authorization: Bearer 발급받은 토큰'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

NodeJS

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://omni.ibapi.kr/v1/form',
  'headers': {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'Authorization': 'Bearer 발급받은 토큰'
  },
  body: JSON.stringify({
    "messageForm": [
      {
        "rcs": {
          "content": {
            "standalone": {
              "text": "RCS 메시지 내용"
            }
          },
          "from": "발신번호",
          "formatId": "SS000000"
        }
      },
      {
        "sms": {
          "from": "발신번호",
          "text": "SMS 메시지 내용"
        }
      }
    ]
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

C#

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://omni.ibapi.kr/v1/form");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer 발급받은 토큰");
var content = new StringContent("{\"messageForm\":[{\"rcs\":{\"content\":{\"standalone\":{\"text\":\"RCS 메시지 내용\"}},\"from\":\"발신번호\",\"formatId\":\"SS000000\"}},{\"sms\":{\"from\":\"발신번호\",\"text\":\"SMS 메시지 내용\"}}]}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

JavaScript

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Accept", "application/json");
myHeaders.append("Authorization", "Bearer 발급받은 토큰");

var raw = JSON.stringify({
  "messageForm": [
    {
      "rcs": {
        "content": {
          "standalone": {
            "text": "RCS 메시지 내용"
          }
        },
        "from": "발신번호",
        "formatId": "SS000000"
      }
    },
    {
      "sms": {
        "from": "발신번호",
        "text": "SMS 메시지 내용"
      }
    }
  ]
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://omni.ibapi.kr/v1/form", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

python

import http.client
import json

conn = http.client.HTTPSConnection("omni.ibapi.kr")
payload = json.dumps({
  "messageForm": [
    {
      "rcs": {
        "content": {
          "standalone": {
            "text": "RCS 메시지 내용"
          }
        },
        "from": "발신번호",
        "formatId": "SS000000"
      }
    },
    {
      "sms": {
        "from": "발신번호",
        "text": "SMS 메시지 내용"
      }
    }
  ]
})
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer 발급받은 토큰'
}
conn.request("POST", "/v1/form", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Ruby

require "uri"
require "json"
require "net/http"

url = URI("https://omni.ibapi.kr/v1/form")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Accept"] = "application/json"
request["Authorization"] = "Bearer 발급받은 토큰"
request.body = JSON.dump({
  "messageForm": [
    {
      "rcs": {
        "content": {
          "standalone": {
            "text": "RCS 메시지 내용"
          }
        },
        "from": "발신번호",
        "formatId": "SS000000"
      }
    },
    {
      "sms": {
        "from": "발신번호",
        "text": "SMS 메시지 내용"
      }
    }
  ]
})

response = https.request(request)
puts response.read_body

Response

Header

Name	Type	Description
Content-Type	String	application/json

Body

Name	Type	Description
code	String(4)	API 호출 결과 코드
result	String	API 호출 결과 설명
data	Object Name Type Description formId String 메시지 폼 ID expired String 메시지 폼 ID만료 일시(ISO 8601, yyyy-MM-dd'T'HH:mm:ssXXX)	API 호출 결과 데이터

HTTP 200(성공:Success)

{
    "code": "A000",
    "result": "Success",
    "data": {
        "formId": "20240000000000000R1000000",
        "expired": "2024-00-00T00:00:00+09:00"        
    }
}

HTTP 400(실패:Bad Request)

{
    "code": "A010",
    "result": "Cannot parse JSON"
}

HTTP 401(실패:Unauthorized)

{
    "code": "A001",
    "result": "Expired token"
}

HTTP 500(실패:Forbidden)

{
    "code": "A999",
    "result": "Unknown error"
}

Schema

messageForm

Array 순서대로 전송, Fallback 처리 됩니다.

Name	Type	Required	Description
sms	Object	NO	SMS 메시지 정보
mms	Object	NO	MMS 메시지 정보
rcs	Object	NO	RCS 메시지 정보
alimtalk	Object	NO	카카오 알림톡 메시지 정보
friendtalk	Object	NO	카카오 친구톡 메시지 정보

메시지 정보 세부 사양은 전송(통합메시지) messageFlow 부분을 참고 해주시기 바랍니다.

메시지 폼 조회

GET /v1/form/{formId}

Request

Header

Name	Type	Description
Authorization	String	schema + “ “ + token
Accept	String	application/json

Path Parameter

Name	Type	Required	Description
formId	String	YES	메시지 폼 ID

cURL

curl -X GET https://omni.ibapi.kr/v1/form/메시지폼ID \
-H "Accept: application/json" \
-H "Authorization:Bearer 발급받은 토큰"

JAVA

import java.io.*;
import okhttp3.*;
public class Main {
  public static void main(String []args) throws IOException{
    OkHttpClient client = new OkHttpClient().newBuilder()
      .build();
    MediaType mediaType = MediaType.parse("text/plain");
    RequestBody body = RequestBody.create(mediaType, "");
    Request request = new Request.Builder()
      .url("https://omni.ibapi.kr/v1/form/formId")
      .method("GET", body)
      .addHeader("Accept", "application/json")
      .addHeader("Authorization", "Bearer 발급받은 토큰")
      .build();
    Response response = client.newCall(request).execute();
    System.out.println(response.body().string());
  }
}

Go

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://omni.ibapi.kr/v1/form/formId"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Accept", "application/json")
  req.Header.Add("Authorization", "Bearer 발급받은 토큰")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://omni.ibapi.kr/v1/form/formId',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Accept: application/json',
    'Authorization: Bearer 발급받은 토큰'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

NodeJS

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://omni.ibapi.kr/v1/form/formId',
  'headers': {
    'Accept': 'application/json',
    'Authorization': 'Bearer 발급받은 토큰'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

C#

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://omni.ibapi.kr/v1/form/formId");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer 발급받은 토큰");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

JavaScript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Authorization", "Bearer 발급받은 토큰");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://omni.ibapi.kr/v1/form/formId", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

python

import http.client

conn = http.client.HTTPSConnection("omni.ibapi.kr")
payload = ''
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer 발급받은 토큰'
}
conn.request("GET", "/v1/form/formId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Ruby

require "uri"
require "net/http"

url = URI("https://omni.ibapi.kr/v1/form/formId")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Authorization"] = "Bearer 발급받은 토큰"

response = https.request(request)
puts response.read_body

Response

Header

Name	Type	Description
Content-Type	String	application/json

Body

Name	Type	Description
code	String(4)	API 호출 결과 코드
result	String	API 호출 결과 설명
data	Object Name Type Description formId String 메시지 폼 ID messageForm Object Array 등록된 메시지 폼 expired String 메시지폼 ID만료 일시(ISO 8601, yyyy-MM-dd'T'HH:mm:ssXXX)	API 호출 결과 데이터

HTTP 200(성공:Success)

{
    "code": "A000",
    "result": "Success",
    "data": {
        "formId": "20240000000000000R1000000",
        "expired": "2024-00-00 00:00:00",
        "messageForm": [           
            {
                "mms": {
                    "from": "0316281500",
                    "text": "This is an MMS message with media",
                    "title": "MMS Title",
                    "fileKey": [
                        "file123",
                        "file456",
                        "file789"
                    ],
                    "ttl": "86400"
                }
            },
            {
                "sms": {
                    "from": "0316281500",
                    "text": "This is an SMS message",
                    "ttl": "86400"
                }
            }
        ]        
    }
}

HTTP 400(실패:Bad Request)

{
    "code": "A010",
    "result": "Cannot parse JSON"
}

HTTP 401(실패:Unauthorized)

{
    "code": "A001",
    "result": "Expired token"
}

HTTP 500(실패:Forbidden)

{
    "code": "A999", 
    "result": "Unknown error"
}

메시지 폼 수정

PUT /v1/form/{formId}

Request

Header

Name	Type	Description
Authorization	String	schema + “ “ + token
Content-Type	String	application/json
Accept	String	application/json

Path Parameter

Name	Type	Required	Description
formId	String	YES	메시지폼 ID

Body

Name	Type	Required	Description
messageForm	Object Array	YES	메시지폼 정보

cURL

curl -X PUT https://omni.ibapi.kr/v1/form/메시지폼ID \
-H "content-type: application/json" \
-H "Accept: application/json" \
-H "Authorization:Bearer 발급받은 토큰" \
-d '{"messageForm":[{"rcs":{"content":{"standalone":{"text":"RCS 메시지 내용"}},"from":"발신번호","formatId":"SS000000"}},{"sms":{"from":"발신번호","text":"SMS 메시지 내용"}}]}'

JAVA

import java.io.*;
import okhttp3.*;
public class Main {
  public static void main(String []args) throws IOException{
    OkHttpClient client = new OkHttpClient().newBuilder()
      .build();
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\"messageForm\":[{\"rcs\":{\"content\":{\"standalone\":{\"text\":\"RCS 메시지 내용\"}},\"from\":\"발신번호\",\"formatId\":\"SS000000\"}},{\"sms\":{\"from\":\"발신번호\",\"text\":\"SMS 메시지 내용\"}}]}");
    Request request = new Request.Builder()
      .url("https://omni.ibapi.kr/v1/form/formId")
      .method("PUT", body)
      .addHeader("Content-Type", "application/json")
      .addHeader("Accept", "application/json")
      .addHeader("Authorization", "Bearer 발급받은 토큰")
      .build();
    Response response = client.newCall(request).execute();
    System.out.println(response.body().string());
  }
}

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://omni.ibapi.kr/v1/form/formId"
  method := "PUT"

  payload := strings.NewReader(`{"messageForm":[{"rcs":{"content":{"standalone":{"text":"RCS 메시지 내용"}},"from":"발신번호","formatId":"SS000000"}},{"sms":{"from":"발신번호","text":"SMS 메시지 내용"}}]}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Accept", "application/json")
  req.Header.Add("Authorization", "Bearer 발급받은 토큰")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://omni.ibapi.kr/v1/form/formId',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_POSTFIELDS =>'{"messageForm":[{"rcs":{"content":{"standalone":{"text":"RCS 메시지 내용"}},"from":"발신번호","formatId":"SS000000"}},{"sms":{"from":"발신번호","text":"SMS 메시지 내용"}}]}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Accept: application/json',
    'Authorization: Bearer 발급받은 토큰'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

NodeJS

var request = require('request');
var options = {
  'method': 'PUT',
  'url': 'https://omni.ibapi.kr/v1/form/formId',
  'headers': {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'Authorization': 'Bearer 발급받은 토큰'
  },
  body: JSON.stringify({
    "messageForm": [
      {
        "rcs": {
          "content": {
            "standalone": {
              "text": "RCS 메시지 내용"
            }
          },
          "from": "발신번호",
          "formatId": "SS000000"
        }
      },
      {
        "sms": {
          "from": "발신번호",
          "text": "SMS 메시지 내용"
        }
      }
    ]
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
}

C#

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://omni.ibapi.kr/v1/form/formId");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer 발급받은 토큰");
var content = new StringContent("{\"messageForm\":[{\"rcs\":{\"content\":{\"standalone\":{\"text\":\"RCS 메시지 내용\"}},\"from\":\"발신번호\",\"formatId\":\"SS000000\"}},{\"sms\":{\"from\":\"발신번호\",\"text\":\"SMS 메시지 내용\"}}]}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

JavaScript

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Accept", "application/json");
myHeaders.append("Authorization", "Bearer 발급받은 토큰");

var raw = JSON.stringify({
  "messageForm": [
    {
      "rcs": {
        "content": {
          "standalone": {
            "text": "RCS 메시지 내용"
          }
        },
        "from": "발신번호",
        "formatId": "SS000000"
      }
    },
    {
      "sms": {
        "from": "발신번호",
        "text": "SMS 메시지 내용"
      }
    }
  ]
});

var requestOptions = {
  method: 'PUT',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://omni.ibapi.kr/v1/form/formId", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

python

import http.client
import json

conn = http.client.HTTPSConnection("omni.ibapi.kr")
payload = json.dumps({
  "messageForm": [
    {
      "rcs": {
        "content": {
          "standalone": {
            "text": "RCS 메시지 내용"
          }
        },
        "from": "발신번호",
        "formatId": "SS000000"
      }
    },
    {
      "sms": {
        "from": "발신번호",
        "text": "SMS 메시지 내용"
      }
    }
  ]
})
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer 발급받은 토큰'
}
conn.request("PUT", "/v1/form/formId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Ruby

require "uri"
require "json"
require "net/http"

url = URI("https://omni.ibapi.kr/v1/form/formId")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = "application/json"
request["Accept"] = "application/json"
request["Authorization"] = "Bearer 발급받은 토큰"
request.body = JSON.dump({
  "messageForm": [
    {
      "rcs": {
        "content": {
          "standalone": {
            "text": "RCS 메시지 내용"
          }
        },
        "from": "발신번호",
        "formatId": "SS000000"
      }
    },
    {
      "sms": {
        "from": "발신번호",
        "text": "SMS 메시지 내용"
      }
    }
  ]
})

response = https.request(request)
puts response.read_body

Response

Header

Name	Type	Description
Content-Type	String	application/json

Body

Name	Type	Description
code	String(4)	API 호출 결과 코드
result	String	API 호출 결과 설명
data	Object Name Type Description formId String 메시지 폼 ID expired String 메시지 폼 ID만료 일시(ISO 8601, yyyy-MM-dd'T'HH:mm:ssXXX)	API 호출 결과 데이터

HTTP 200(성공:Success)

{
    "code": "A000",
    "result": "Success",
    "data": {
        "formId": "20240000000000000R1000000",
        "expired": "2024-00-00 00:00:00"        
    }
}

HTTP 400(실패:Bad Request)

{
    "code": "A010",
    "result": "Cannot parse JSON"
}

HTTP 401(실패:Unauthorized)

{
    "code": "A001",
    "result": "Expired token"
}

HTTP 500(실패:Forbidden)

{
    "code": "A999",
    "result": "Unknown error"

}

메시지 폼 삭제

DELETE /v1/form/{formId}

Request

Header

Name	Type	Description
Authorization	String	schema + “ “ + token
Accept	String	application/json

Path Parameter

Name	Type	Required	Description
formId	String	YES	메시지폼 ID

cURL

curl -X DELETE https://omni.ibapi.kr/v1/form/메시지폼ID \
-H "Accept: application/json" \
-H "Authorization:Bearer 발급받은 토큰" 

JAVA

import java.io.*;
import okhttp3.*;
public class Main {
  public static void main(String []args) throws IOException{
    OkHttpClient client = new OkHttpClient().newBuilder()
      .build();
    MediaType mediaType = MediaType.parse("text/plain");
    RequestBody body = RequestBody.create(mediaType, "");
    Request request = new Request.Builder()
      .url("https://omni.ibapi.kr/v1/form/formId")
      .method("DELETE", body)
      .addHeader("Accept", "application/json")
      .addHeader("Authorization", "Bearer 발급받은 토큰")
      .build();
    Response response = client.newCall(request).execute();
    System.out.println(response.body().string());
  }
}

Go

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://omni.ibapi.kr/v1/form/formId"
  method := "DELETE"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Accept", "application/json")
  req.Header.Add("Authorization", "Bearer 발급받은 토큰")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://omni.ibapi.kr/v1/form/formId',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'DELETE',
  CURLOPT_HTTPHEADER => array(
    'Accept: application/json',
    'Authorization: Bearer 발급받은 토큰'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

NodeJS

var request = require('request');
var options = {
  'method': 'DELETE',
  'url': 'https://omni.ibapi.kr/v1/form/formId',
  'headers': {
    'Accept': 'application/json',
    'Authorization': 'Bearer 발급받은 토큰'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

C#

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://omni.ibapi.kr/v1/form/formId");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer 발급받은 토큰");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

JavaScript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Authorization", "Bearer 발급받은 토큰");

var requestOptions = {
  method: 'DELETE',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://omni.ibapi.kr/v1/form/formId", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

python

import http.client

conn = http.client.HTTPSConnection("omni.ibapi.kr")
payload = ''
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer 발급받은 토큰'
}
conn.request("DELETE", "/v1/form/formId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Ruby

require "uri"
require "net/http"

url = URI("https://omni.ibapi.kr/v1/form/formId")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Accept"] = "application/json"
request["Authorization"] = "Bearer 발급받은 토큰"

response = https.request(request)
puts response.read_body

Response

Header

Name	Type	Description
Content-Type	String	application/json

Body

Name	Type	Description
code	String(4)	API 호출 결과 코드
result	String	API 호출 결과 설명

HTTP 200(성공:Success)

{
    "code": "A000",
    "result": "Success"
}

HTTP 400(실패:Bad Request)

{
    "code": "A010",
    "result": "Cannot parse JSON"
} 

HTTP 401(실패:Unauthorized)

{
    "code": "A001",
    "result": "Expired token"
}

HTTP 500(실패:Forbidden)

{
    "code": "A999",
    "result": "Unknown error"
}